diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 0000000..a513360 --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 76328e810a661d390544b929568a96f0 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.gitignore b/.gitignore deleted file mode 100644 index faa97aa..0000000 --- a/.gitignore +++ /dev/null @@ -1,10 +0,0 @@ -# Generated files: -.mypy_cache -__pycache__ -.vscode - -# The 'bin/' directory: -bin -docs/build -docs/mobase.py -docs/source/api \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index e8dc520..0000000 --- a/LICENSE +++ /dev/null @@ -1,7 +0,0 @@ -Copyright 2020 MikaĆ«l Capelle - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index a6e745e..0000000 --- a/README.md +++ /dev/null @@ -1,141 +0,0 @@ -# Mod Organizer 2 - Python stubs generation - -This little project can be used to generate python stubs (`.pyi` file) for the MO2 python -interface `mobase`. - -## Using the stubs - -You can install the `stubs` with `pip`: - -```bash -pip install mobase-stubs -``` - -This will install the latest stubs on PyPi which usually corresponds to the latest release of -MO2. -You can install stubs for a specific version of MO2: - -```bash -pip install mobase-stubs==2.3.2.* -``` - -If you want development stubs, you can install them this way: -```bash -# Clone this repository: -git clone https://github.com/ModOrganizer2/pystubs-generation.git - -# Install the stubs: -cd pystubs-generation/stubs/setup -pip install . -``` - -Some words of warning: -- The stubs are as correct as possible, but some errors are expected. -- If you see a `InterfaceNotImplemented` class anywhere in the stubs, it means that a proper interface is - currently not available. -- Some classes are said (in the stubs) to inherit `QWidget` or `QObject`. This is true on the C++ side but NOT - on the python side. The inheritance is only added to help with auto-completion since these classes also - override `__getattr__` to dispatch to the underlying `QWidget` or `QObject`. Some things might not work as - expected with these class (e.g., `isintance(myObject, QObject)` will return `False`), which is why a - `_object()` and `_widget()` method is also provided. - -## Generating the stubs - -The stubs are generated using python by parsing the `mobase` module. -You need the version of python that matches your current MO2 installation: e.g., if you have a `python38.dll` in -your MO2 installation path, then you need **python 3.8**. - -To generate the stubs, you can run: - -``` -# Change the output folder to whatever you want: -python main.py -c configs\config-2.3.yml -o stubs\setup\mobase-stubs\__init__.pyi ${MO2_INSTALL_PATH} -``` - -Where `${MO2_INSTALL_PATH}` is the path to your MO2 installation (the one containing `ModOrganizer.exe`). - -The latest stubs are kept under `stubs/setup/mobase-stubs/__init__.pyi`, and when a new version is released, -the stubs are backed-up under `stubs/x.y.z/mobase.pyi`. - - -If you do not specify a `-o` option, output will go to `stdout`, so you should redirect. -Warning and "critical" messages are printed to `stderr`. - -A few options are available for `main.py`: - -``` -usage: Stubs generator for the MO2 python interface [-h] [-o OUTPUT] [-v] [-c CONFIG] INSTALL_DIR - -positional arguments: - INSTALL_DIR installation directory of Mod Organizer 2 - -optional arguments: - -h, --help show this help message and exit - -o OUTPUT, --output OUTPUT - output file (output to stdout if not specified) - -v, --verbose verbose mode (all logs go to stderr) - -c CONFIG, --config CONFIG - configuration file -``` - -The stubs generator will try hard to find a valid stubs for all classes and methods of `mobase`. -A lot of information is available through the `-v` options. Without it, only conversions or fixes -considered "strange" will be outputed. -For instance, here is the output with the current `config-2.3.yml` file: - -``` -WARNING: Replacing IOrganizer::FileInfo with FileInfo. -WARNING: Replacing IOrganizer::FileInfo with FileInfo. -WARNING: Replacing IPluginInstaller::EInstallResult with InstallResult. -WARNING: Replacing IPluginInstaller::EInstallResult with InstallResult. -``` - -As you can see, only a few types were manually fixed (specified in `config-2.3.yml`). - -## Configuration file - -The configuration file contains information for the stubs that cannot be deduced by `main` (or are too -complex to deduce), and the documentation for everything. - -## Uploading the stubs to pypi - -The upload of the stubs to https://pypi.org/project/mobase-stubs/ has to be done manually. Here -are the steps: - -1. Check the version of the stubs: - - The version is specified in the configuration file. If you need to modify the stubs of the - current version, you need to add a `.postX` after the version since PyPi does not allow - re-upload of the same release. -2. Generate the stubs using the procedure above. You should generate the stubs under `stubs/setup/mobase-stubs/__init__.pyi`. -3. If necessary, update the dependencies in `setup.py` (`PyQt5-stubs` version and python version). -4. Go to `stubs/setup` and run: - -```bash -python setup.py sdist bdist_wheel -twine upload dist/* -``` - -You need to set the environment variables `TWINE_USERNAME` and `TWINE_PASSWORD` to appropriate values -before running `twine upload`. - -## Extras — Starts a python interpreter with `mobase` - -It is possible to start a (i)python interpret with `mobase` imported by running: - -``` -python -im generator.loader ${MO2_INSTALL_PATH} -``` - -This has no real usage except for MO2 developers since most classes from the `mobase` module cannot be instantiated. - -# License - -The MIT License (MIT) - -Copyright (c) 2020, Holt59. - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -See [LICENSE](LICENSE). \ No newline at end of file diff --git a/configs/config-2.3.yml b/configs/config-2.3.yml deleted file mode 100644 index 3737fc8..0000000 --- a/configs/config-2.3.yml +++ /dev/null @@ -1,2631 +0,0 @@ ---- -version: 1 - -# This is the list of type to replace: -replacements: - Organizer::FileInfo: FileInfo - IOrganizer::FileInfo: FileInfo - IPluginInstaller::EInstallResult: InstallResult - -# List of names to ignores: -ignores: - - toPyQt - -# This is the root of the mobase module and will contain everything -# related to functions / classes, including their documentation. -mobase: - - # Version of the stubs. - __version__: 2.3.2.post2 - - getFileVersion: - __doc__: Retrieve the file version of the given executable. - args: - filepath: Absolute path to the executable. - returns: | - The file version, or an empty string if the file version could not be retrieved. - - getIconForExecutable: - __doc__: Retrieve the icon of an executable. Currently this always extracts the biggest icon. - args: - executable: Absolute path to the executable. - returns: The icon for this executable, if any. - - getProductVersion: - __doc__: Retrieve the product version of the given executable. - args: - executable: Absolute path to the executable. - returns: | - The product version, or an empty string if the product version could not be retrieved. - - GuessQuality: - __doc__: | - Describes how good the code considers a guess (i.e. for a mod name) this is used to - determine if a name from another source should overwrite or not. - - INVALID: No valid value has been set yet. - FALLBACK: The guess is very basic and should only be used if no other source is available. - GOOD: Considered a good guess. - META: The value comes from metadata and is usually what the author intended. - PRESET: | - The value comes from a previous installation of the same data/mod and usually represents - what the user chose before. - USER: The user selection, always overrules other sources. - - InstallResult: - __doc__: - SUCCESS: - FAILED: - CANCELED: - MANUAL_REQUESTED: - NOT_ATTEMPTED: - - LoadOrderMechanism: - __doc__: - FILE_TIME: Order of plugins is determined by the filetime of the plugins. - PLUGINS_TXT: Order of plugins is determined by the plugins.txt file. - - ModState: - __doc__: - EXISTS: - ACTIVE: - ESSENTIAL: - EMPTY: - ENDORSED: - VALID: - ALTERNATE: - - PluginState: - __doc__: - MISSING: - INACTIVE: - ACTIVE: - - ProfileSetting: - __doc__: - MODS: - CONFIGURATION: - SAVEGAMES: - PREFER_DEFAULTS: - - ReleaseType: - __doc__: - PRE_ALPHA: - ALPHA: - BETA: - CANDIDATE: - FINAL: - - SortMechanism: - __doc__: - NONE: - MLOX: - BOSS: - LOOT: - - VersionScheme: - __doc__: - DISCOVER: - REGULAR: - DECIMAL_MARK: - NUMBERS_AND_LETTERS: - DATE: - LITERAL: - - # TODO: - BSAInvalidation: - __doc__: - __abstract__: true - __init__: - __doc__: - activate: - __doc__: - args: - profile: - deactivate: - __doc__: - args: - profile: - isInvalidationBSA: - __doc__: - args: - name: - returns: - - DataArchives: - __abstract__: true - - addArchive: - __doc__: Add an archive to the archive list. - args: - profile: Profile to add the archive to. - index: | - Index to insert before. Use 0 for the beginning of the list or INT_MAX for - the end of the list). - name: Name of the archive to add. - - archives: - __doc__: Retrieve the list of archives in the given profile. - args: - profile: Profile to retrieve archives from. - returns: The list of archives in the given profile. - - removeArchive: - __doc__: Remove the given archive from the given profile. - args: - profile: Profile to remove the archive from. - name: Name of the archive to remove. - - vanillaArchives: - __doc__: | - Retrieve the list of vanilla archives. - - Vanilla archives are archive files that are shipped with the original - game. - returns: The list of vanilla archives. - - ExecutableForcedLoadSetting: - __doc__: - __init__: - __doc__: - args: - process: - library: - enabled: - __doc__: - returns: - forced: - __doc__: - returns: - library: - __doc__: - returns: - process: - __doc__: - returns: - withEnabled: - __doc__: - args: - enabled: - returns: - withForced: - __doc__: - args: - forced: - returns: - - ExecutableInfo: - __doc__: - __init__: - __doc__: - args: - title: - binary: - arguments: - __doc__: - returns: - asCustom: - __doc__: - returns: - binary: - __doc__: - returns: - isCustom: - __doc__: - returns: - isValid: - __doc__: - returns: - steamAppID: - __doc__: - returns: - title: - __doc__: - returns: - withArgument: - __doc__: - args: - argument: - returns: - withSteamAppId: - __doc__: - args: - app_id: - returns: - withWorkingDirectory: - __doc__: - args: - directory: - returns: - workingDirectory: - __doc__: - returns: - - FileInfo: - __doc__: Information about a virtualised file - properties[]: - archive: - type: str - desc: | - Name of the archive if this file is in an archive (e.g. BSA), otherwise an - empty string. - filePath: - type: str - desc: Full path to the file. - origins: - type: List[str] - desc: | - List of origins containing providing this file. The first origin in the list - is the highest priority one (actually providing the file). - - __init__: - __doc__: Creates an uninitialized FileInfo. - - FileTreeEntry: - __doc__: | - Represent an entry in a file tree, either a file or a directory. This class - inherited by IFileTree so that operations on entry are the same for a file or - a directory. - - This class provides convenience methods to query information on the file, like its - name or the its last modification time. It also provides a convenience astree() method - that can be used to retrieve the tree corresponding to its entry in case the entry - represent a directory. - - FileTypes: - __doc__: Enumeration of the different file type or combinations. - DIRECTORY: - FILE: - FILE_OR_DIRECTORY: - - detach: - __doc__: Detach this entry from its parent tree. - returns: True if the entry was removed correctly, False otherwize. - - fileType: - returns: The filetype of this entry. - - hasSuffix.1: - __doc__: Check if this entry has one of the given suffixes. - args: - suffixes: Suffixes to check. - returns: True if this entry is a file and has one of the given suffix. - - hasSuffix.2: - __doc__: Check if this entry has the given suffix. - args: - suffix: Suffix to check. - returns: True if this entry is a file and has the given suffix. - - isDir: - returns: True if this entry is a directory, False otherwise. - - isFile: - returns: True if this entry is a file, False otherwise. - - moveTo: - __doc__: Move this entry to the given tree. - args: - tree: The tree to move this entry to. - returns: True if the entry was moved correctly, False otherwize. - - name: - returns: The name of this entry. - - parent: - returns: - __doc__: | - The parent tree containing this entry, or a `None` if this entry is the root - or the parent tree is unreachable. - type: Optional["IFileTree"] - - path: - __doc__: | - Retrieve the path from this entry up to the root of the tree. - - This method propagate up the tree so is not constant complexity as - the full path is never stored. - args: - sep: The type of separator to use to create the path. - returns: The path from this entry to the root, including the name of this entry. - - pathFrom: - __doc__: Retrieve the path from the given tree to this entry. - args: - tree: The tree to reach, must be a parent of this entry. - sep: The type of separator to use to create the path. - returns: | - The path from the given tree to this entry, including the name of this entry, or - an empty string if the given tree is not a parent of this entry. - - suffix: - __doc__: | - Retrieve the "last" extension of this entry. - - The "last" extension is everything after the last dot in the file name. - returns: | - The last extension of this entry, or an empty string if the file has no extension - or is directory. - - GamePlugins: - __abstract__: true - getLoadOrder: - __doc__: - returns: - lightPluginsAreSupported: - returns: True if light plugins are supported, False otherwise. - readPluginLists: - __doc__: - args: - plugin_list: - writePluginLists: - __doc__: - args: - plugin_list: - - GuessedString: - __doc__: | - Represents a string that may be set from different places. Each time the value is - changed a "quality" is specified to say how probable it is the value is the best choice. - Only the best choice should be used in the end but alternatives can be queried. This - class also allows a filter to be set. If a "guess" doesn't pass the filter, it is ignored. - - __init__.1: - __doc__: Creates a GuessedString with no associated value. - - __init__.2: - __doc__: Creates a GuessedString with the given value and quality. - args: - value: Initial value of the GuessedString. - quality: Quality of the initial value. - - reset.1: - __doc__: Reset this GuessedString to an invalid state. - returns: This GuessedString object. - - reset.2: - __doc__: | - Reset this GuessedString object with the given value and quality, only - if the given quality is better than the current one. - args: - value: New value for this GuessedString. - quality: Quality of the new value. - returns: This GuessedString object. - - reset.3: - __doc__: | - Reset this GuessedString object by copying the given one, only - if the given one has better quality. - args: - other: The GuessedString to copy. - returns: This GuessedString object. - - setFilter: - __doc__: | - Set the filter for this GuessedString. - - The filter is applied on every `update()` and can reject the new value - altogether or modify it (by returning a new value). - args: - filter: The new filter. - - update.1: - __doc__: | - Update this GuessedString by adding the given value to the list of variants - and setting the actual value without changing the current quality of this - GuessedString. - - The GuessedString is only updated if the given value passes the filter. - args: - value: The new value for this string. - returns: This GuessedString object. - - update.2: - __doc__: | - Update this GuessedString by adding a new variants with the given quality. - - If the specified quality is better than the current one, the actual value of - the GuessedString is also updated. - - The GuessedString is only updated if the given value passes the filter. - args: - value: The new variant to add. - quality: The quality of the variant. - returns: This GuessedString object. - - variants: - returns: The list of variants for this GuessedString. - - IDownloadManager: - __bases__: - - PyQt5.QtCore.QObject - - signals[]: - downloadComplete: - __doc__: Emitted when a download finishes completely (including retrieval of meta information). - args: - id: - type: int - desc: ID of the download. - downloadPaused: - __doc__: Emitted when a download is paused by the user. - args: - id: - type: int - desc: ID of the download. - downloadFailed: - __doc__: Emitted when a download fails. - args: - id: - type: int - desc: ID of the download. - downloadRemoved: - __doc__: Emitted when a download is removed from the manager. The ID of the download is no longer valid. - args: - id: - type: int - desc: ID of the download. - - _object: - returns: The underlying `QObject` for the manager. - - downloadPath: - __doc__: Retrieve the (absolute) path of the specified download. - args: - id: ID of the download. - returns: | - The absolute path to the file corresponding to the given download. This file - may not exist yet if the download is incomplete. - - startDownloadNexusFile: - __doc__: | - Download a file from www.nexusmods.com/. is always the game - currently being managed. - args: - mod_id: ID of the mod to download the file from. - file_id: ID of the file to download. - returns: An ID identifying the download. - - startDownloadURLs: - __doc__: | - Download a file by url. - - The list can contain alternative URLs to allow the download manager to switch - in case of download problems - args: - urls: List of urls to download from. - returns: An ID identifying the download. - - IFileTree: - __doc__: | - Interface to classes that provides way to visualize and alter file trees. The tree - may not correspond to an actual file tree on the disk (e.g., inside an archive, - from a QTree Widget, ...). - - Read-only operations on the tree are thread-safe, even when the tree has not been populated - yet. - - In order to prevent wrong usage of the tree, implementing classes may throw - UnsupportedOperationException if an operation is not supported. By default, all operations - are supported, but some may not make sense in many situations. - - The goal of this is not reflect the change made to a IFileTree to the disk, but child - classes may override relevant methods to do so. - - The tree is built upon FileTreeEntry. A given tree holds shared pointers to its entries - while each entry holds a weak pointer to its parent, this means that the descending link - are strong (shared pointers) but the uplink are weaks. - - Accessing the parent is always done by locking the weak pointer so that returned pointer - or either null or valid. This structure implies that as long as the initial root lives, - entry should not be destroyed, unless the entry are detached from the root and no shared - pointers are kept. - - However, it is not guarantee that one can go up the tree from a single node entry. If the - root node is destroyed, it will not be possible to go up the tree, even if we still have - a valid shared pointer. - - InsertPolicy: - __doc__: - FAIL_IF_EXISTS: Operation will fail if the destination already exists. - REPLACE: | - If the destination exists, it will be replaced (even if the source is a file and - the destination a directory). - MERGE: | - If the destination exists, and the source and destination are of the same type (e.g. - two files or two folders), a merge is performed: if both entries are files, the source - replaces the destination, otherwise the source is merged into the destination. If the - destination exists but the source and the destination are of different type, the - operation fails. - - WalkReturn: - __doc__: | - Enumeration that can be returned by the callback for the `walk()` method to stop the - walking operation early. - CONTINUE: Continue walking normally. - STOP: Stop the walking operation. - SKIP: Skip this folder (no effect if the entry is a file). - - __bool__: - returns: True if this tree is not empty, False otherwise. - - __getitem__: - __doc__: Retrieve the entry at the given index in this tree. - args: - index: Index of the entry to retrieve, must be less than the size. - returns: The entry at the given index. - raises: - IndexError: If the given index is not in range for this tree. - - __iter__: - __doc__: | - Retrieves an iterator for entries directly under this tree. - - This method does not recurse into subtrees, see `walk()` for this. - - # Force the list of arguments to be empty (this will still include self): - args: - - # We are forcing the return type because parsing C++ iterators is a pain: - returns: - __doc__: An iterator object that can be used to iterate over entries in this tree. - type: "Iterator[FileTreeEntry]" - - __len__: - returns: The number of entries directly under this tree. - - addDirectory: - __doc__: | - Create a new directory tree under this tree. - - This method will create missing folders in the given path and will - not fail if the directory already exists but will fail if the given - path contains "." or "..". - This method invalidates iterators to this tree and all the subtrees - present in the given path. - args: - path: Path to the directory to create. - returns: An IFileTree corresponding to the created directory. - raises: - RuntimeError: If the directory could not be created. - - addFile: - __doc__: | - Create a new file directly under this tree. - - This method will fail if the file already exists and `replace_if_exists` is `False`. - This method invalidates iterators to this tree and all the subtrees present in the - given path. - args: - path: Path to the file to create. - replace_if_exists: | - If True and an entry already exists at the given location, it will be replaced by - a new entry. This will replace both files and directories. - returns: A FileTreeEntry corresponding to the created file. - raises: - RuntimeError: If the file could not be created. - - clear: - __doc__: | - Delete (detach) all the entries from this tree. - - This method will go through the entries in this tree and stop at the first - entry that cannot be deleted, this means that the tree can be partially cleared. - returns: True if all entries have been detached, False otherwise. - - copy: - __doc__: | - Move the given entry to the given path under this tree. - - The entry must not be a parent tree of this tree. This method can also be used - to rename entries. - - If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry - at the same location already exists. If the policy is REPLACE, an existing - entry will be replaced. If MERGE, the entry will be merged with the existing - one (if the entry is a file, and a file exists, the file will be replaced). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - args: - entry: Entry to copy. - path: | - The path to copy the entry to. If the path ends with / or \\, the entry will - be copied in the corresponding directory instead of replacing it. If the - given path is empty (`""`), the entry is copied directly under this tree. - policy: Policy to use to resolve conflicts. - returns: The new entry (copy of the specified entry). - raises: - RuntimeError: If the entry could not be copied. - - createOrphanTree: - __doc__: Create a new orphan empty tree. - args: - name: Name of the tree. - returns: A new tree without any parent. - - exists: - __doc__: Check if the given entry exists. - args: - path: Path to the entry, separated by / or \\. - type: The type of the entry to check. - returns: True if the entry was found, False otherwise. - - find: - __doc__: | - Retrieve the given entry. - - If no entry exists at the given path, or if the entry is not of the right - type, `None` is returned. - args: - path: Path to the entry, separated by / or \\. - type: The type of the entry to check. - returns: - __doc__: | - The entry at the given location, or `None` if the entry was not found or - was not of the correct type. - type: Optional[Union["IFileTree", "FileTreeEntry"]] - - insert: - __doc__: | - Insert the given entry in this tree, removing it from its - previouis parent. - - The entry must not be this tree or a parent entry of this tree. - - - If the insert policy if `FAIL_IF_EXISTS`, the call will fail if an entry - with the same name already exists. - - If the policy is `REPLACE`, an existing entry will be replaced by the given entry. - - If the policy is `MERGE`: - - - If there is no entry with the same name, the new entry is inserted. - - If there is an entry with the same name: - - - If both entries are files, the old file is replaced by the given entry. - - If both entries are directories, a merge is performed as if using merge(). - - Otherwize the insertion fails (two entries with different types). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - args: - entry: Entry to insert. - policy: Policy to use to resolve conflicts. - returns: True if the entry was insert, False otherwise. - - merge: - __doc__: | - Merge the given tree with this tree, i.e., insert all entries - of the given tree into this tree. - - The tree must not be this tree or a parent entry of this tree. Files present in both tree - will be replaced by files in the given tree. After a merge, the source tree will be - empty but still attached to its parent. - - If `overwrites` is `True`, a map from overriden files to new files will be returned. - - Note that the merge process makes no distinction between files and directories - when merging: if a directory is present in this tree and a file from source - is in conflict with it, the tree will be removed and the file inserted; if a file - is in this tree and a directory from source is in conflict with it, the file will - be replaced with the directory. - - This method invalidates iterators to this tree, all the subtrees under this tree - present in the given path, and all the subtrees of the given source. - args: - other: Tree to merge. - overwrites: If True, a mapping from overriden files to new files will be returned. - returns: | - If `overwrites` is True, a mapping from overriden files to new files, otherwise - the number of overwritten entries. - raises: - RuntimeError: If the merge failed. - - move: - __doc__: | - Move the given entry to the given path under this tree. - - The entry must not be a parent tree of this tree. This method can also be used - to rename entries. - - If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry - at the same location already exists. If the policy is REPLACE, an existing - entry will be replaced. If MERGE, the entry will be merged with the existing - one (if the entry is a file, and a file exists, the file will be replaced). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - args: - entry: Entry to move. - path: | - The path to move the entry to. If the path ends with / or \\, the entry will - be inserted in the corresponding directory instead of replacing it. If the - given path is empty (`""`), this is equivalent to `insert()`. - policy: Policy to use to resolve conflicts. - returns: True if the entry was moved correctly, False otherwise. - - pathTo: - __doc__: Retrieve the path from this tree to the given entry. - args: - entry: The entry to reach, must be in this tree. - sep: The type of separator to use to create the path. - returns: | - The path from this tree to the given entry, including the name of the entry, or - an empty string if the given entry was not found under this tree. - - remove.1: - __doc__: | - Delete the entry with the given name. - - This method does not recurse into subtrees, so the entry should be - accessible directly from this tree. - args: - name: Name of the entry to delete. - returns: True if the entry was deleted, False otherwise. - - remove.2: - __doc__: Delete the given entry. - args: - entry: Entry to delete. The entry must belongs to this tree (and not to a subtree). - returns: True if the entry was deleted, False otherwise. - - removeAll: - __doc__: | - Delete the entries with the given names from the tree. - - This method does not recurse into subtrees, so only entries accessible - directly from this tree will be removed. This method invalidates iterators. - args: - names: Names of the entries to delete. - returns: The number of deleted entry. - - removeIf: - __doc__: | - Delete entries matching the given predicate from the tree. - - This method does not recurse into subtrees, so only entries accessible - directly from this tree will be removed. This method invalidates iterators. - args: - filter: Predicate that should return true for entries to delete. - returns: The number of deleted entry. - - walk: - __doc__: | - Walk this tree, calling the given function for each entry in it. - - The given callback will be called with two parameters: the path from this tree to the given entry - (with a trailing separator, not including the entry name), and the actual entry. The method returns - a `WalkReturn` object to indicates what to do. - args: - callback: Method to call for each entry in the tree. - sep: Type of separator to use to construct the path. - - IInstallationManager: - __doc__: - - createFile: - __doc__: | - Create a new file on the disk corresponding to the given entry. - - This method can be used by installer that needs to create files that are not in the original - archive. At the end of the installation, if there are entries in the final tree that were used - to create files, the corresponding files will be moved to the mod folder. - - Temporary files corresponding to created files are automatically cleaned up at the end of - the installation. - args: - entry: The entry for which a temporary file should be created. - returns: The path to the created file, or an empty string if the file could not be created. - - extractFile: - __doc__: | - Extract the specified file from the currently opened archive to a temporary - location. - - This method cannot be used to extract directory. - - The call will fail with an exception if no archive is open (plugins deriving from - IPluginInstallerSimple can rely on that, custom installers should not). The temporary - file is automatically cleaned up after the installation. This call can be very slow - if the archive is large and "solid". - args: - entry: Entry corresponding to the file to extract. - silent: If true, the dialog showing extraction progress will not be shown. - returns: | - The absolute path to the temporary file, or an empty string if the file was not extracted. - - extractFiles: - __doc__: | - Extract the specified files from the currently opened archive to a temporary - location. - - This method cannot be used to extract directories. - - The call will fail with an exception if no archive is open (plugins deriving from - IPluginInstallerSimple can rely on that, custom installers should not). The temporary - files are automatically cleaned up after the installation. This call can be very slow - if the archive is large and "solid". - args: - entries: Entries corresponding to the files to extract. - silent: If true, the dialog showing extraction progress will not be shown. - returns: A list containing absolute paths to the temporary files. - - getSupportedExtensions: - returns: The extensions of archives supported by this installation manager. - - installArchive: - __doc__: Install the given archive. - args: - mod_name: Suggested name of the mod. - archive: Path to the archive to install. - mod_id: ID of the mod, if available. - returns: The result of the installation. - - setURL: - __doc__: Set the url associated with the mod being installed. - args: - url: Url to set. - - IModInterface: - - absolutePath: - returns: Absolute path to the mod to be used in file system operations. - - addCategory: - __doc__: Assign a category to the mod. If the named category does not exist it is created. - args: - name: Name of the new category to assign. - - addNexusCategory: - __doc__: | - Set the category id from a nexus category id. Conversion to MO ID happens internally. - - If a mapping is not possible, the category is set to the default value. - args: - category_id: The Nexus category ID. - - categories: - returns: The list of categories assigned to this mod. - - name: - returns: The name of this mod. - - remove: - __doc__: | - Delete the mod from the disc. - - This does not update the global ModInfo structure or indices. - returns: True if the mod was deleted, False otherwise. - - removeCategory: - __doc__: Unassign a category from this mod. - args: - name: Name of the category to remove. - returns: | - True if the category was removed, False otherwise (e.g. if no such category - was assigned). - - setGameName: - __doc__: Set the source game of this mod. - args: - name: The new source game short name of this mod. - - setIsEndorsed: - __doc__: Set endorsement state of the mod. - args: - endorsed: New endorsement state of this mod. - - setName: - __doc__: | - Set the name of this mod. - - This will also update the name of the directory that contains this mod - args: - name: New name for this mod. - returns: | - True if the name was changed, False if an error occured (e.g. if the name is not a valid - directory name). - - setNewestVersion: - __doc__: Set the latest known version of this mod. - args: - version: The latest known version of this mod. - - setNexusID: - __doc__: Set the Nexus ID of this mod. - args: - nexus_id: Thew new Nexus ID of this mod. - - setVersion: - __doc__: Set the version of this mod. - args: - version: The new version of this mod. - - IModList: - __doc__: | - Interface to the mod-list. - - All api functions in this interface work need the internal name of a mod to find a - mod. For regular mods (mods the user installed) the display name (as shown to the user) - and internal name are identical. For other mods (non-MO mods) there is currently no way - to translate from display name to internal name because the display name might not me un-ambiguous. - - allMods: - returns: A list containing the internal names of all installed mods. - - displayName: - __doc__: | - Retrieve the display name of a mod from its internal name. - - If you received an internal name from the API (e.g. `IPluginList.origin`) then you should use - that name to identify the mod in all other api calls but use this function to retrieve the name - to show to the user. - args: - name: Internal name of the mod. - returns: The display name of the given mod. - - onModMoved: - __doc__: Install a handler to be called when a mod is moved. - args: - callback: | - The function to call when a mod is moved. The first argument is the internal name of the - mod, the second argument the old priority and the third argument the new priority. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onModStateChanged: - __doc__: Install a handler to be called when a mod state changes (enabled/disabled, endorsed, ...). - args: - callback: | - The function to call when the state of a mod changes. The first argument is the internal - mod name, and the second one the new state of the mod. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - priority: - __doc__: Retrieve the priority of a mod. - args: - name: Internal name of the mod. - returns: The priority of the given mod. - - setActive: - __doc__: | - Enable or disable a mod. - - Calling this will cause MO to re-evaluate its virtual file system so this is - a fairly expensive call. - args: - name: Internal name of the mod to enable or disable. - active: True to enable the mod, False to disable it. - returns: True on success, False otherwise. - - setPriority: - __doc__: | - Change the priority of a mod. - - `priority` is the new priority after the move. Keep in mind that the mod disappears from its - old location and all mods with higher priority than the moved mod decrease in priority by one. - args: - name: Internal name of the mod. - priority: The new priority of the mod. - returns: | - True if the priority was changed, False otherwise (if the name or priority were invalid). - - state: - __doc__: Retrieve the state of a mod. - args: - name: Internal name of the mod. - returns: The state of the given mod. - - IModRepositoryBridge: - - __bases__: - - PyQt5.QtCore.QObject - - signals[]: - descriptionAvailable: - __doc__: | - Emitted when the description for a mod is reported by the repository. - - Valid keys in `result_data` might change as the repository page is updated. For nexus, the following - keys are valid as of this writing: - 'allow_view', 'ip', 'one_week_ratings', 'date', 'pm_notify', 'OLD_mid', 'OLD_u_downloads', 'game_id', 'OLD_perm_use', 'mod_page_uri', - 'allow_topics', 'has_hot_image', 'id', 'two_weeks_ratings', 'description', 'lastupdate', 'perm_convert', 'author', 'OLD_image', - 'translation_of', 'OLD_mname', 'version', 'allow_rating', 'perm_useinstructions', 'featured_count', 'donate', 'type', 'perm_credits', - 'hidden_reason', 'OLD_views', 'perm_upload', 'has_back_image', 'adult', 'allow_images', 'OLD_endorsements', 'OLD_size', 'name', - 'commenting', 'moderate', 'language', 'perm_others', 'lastcomment', 'OLD_readme', 'summary', 'perm_modify', 'OLD_downloads', - 'lock_comments', 'suggested_category', 'allow_tagging', 'published', 'perm_notes', 'category_id', 'thread_id', 'perm_use', 'wizard_steps' - - This interface is going to be changed at some point to replace resultData with a less "dynamic" data structure. - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: Dict[str, MoVariant] - desc: The data included in the response. - - filesAvailable: - __doc__: Emitted when the list of files for a mod is reported by the repository. - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: List[ModRepositoryFileInfo] - desc: List of file information objects. - - fileInfoAvailable: - __doc__: | - Emitted when information about a file is reported by the repository. - - Valid keys in `result_data` might change as the repository page is updated. For nexus, the following - keys are valid as of this writing: - 'count', 'requirements_alert', 'u_count', 'description', 'uri', 'size', 'owner_id', 'primary', 'manager', - 'version', 'date', 'game_id', 'mod_id', 'category_id', 'id', 'name' - - If you intend to download this file you do not have to request this information manually, you can call - IDownloadManager.startDownloadNexusFile() and let the download manager figure things out. - - This interface is going to be changed at some point to replace resultData with a less "dynamic" data structure. - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: Dict[str, MoVariant] - desc: The data included in the response. - - downloadURLsAvailable: - __doc__: | - Emitted when the list of download urls for a file is returned by the repository. - - This interface is going to be changed at some point to replace resultData with a less "dynamic" data structure. - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - file_id: - type: int - desc: ID of the file for which the request was made. - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: Dict[str, MoVariant] - desc: The data included in the response. - - endorsementsAvailable: - __doc__: Emitted when the endorsement data is returned from the API. - args: - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: bool - desc: The new endorsement state. - - endorsementToggled: - __doc__: Emitted when the endorsement state of a mod was changed (only sent as a result of our request). - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: bool - desc: The new endorsement state. - - trackedModsAvailable: - __doc__: Emitted when the tracked mod data is returned from the API. - args: - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: bool - desc: The new tracking state as a list of maps with keys (domain_name, mod_id). - - trackingToggled: - __doc__: Emitted when the tracking state of a mod was changed (only sent as a result of our request). - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: bool - desc: The new tracking state. - - requestFailed: - __doc__: Emitted when a Nexus request failed. - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - file_id: - type: int - desc: ID of the file for which the request was made (ignore if the request was for a mod in general). - user_data: - type: MoVariant - desc: The data that was included in the request. - error: - type: PyQt5.QtNetwork.QNetworkReply.NetworkError - desc: The actual error. - message: - type: str - desc: Textual description of the error. - - _object: - returns: The underlying `QObject` for the bridge. - - requestDescription: - __doc__: Request description of a mod. - args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - user_data: User data to be returned with the result. - - requestDownloadURL: - __doc__: Request download URL for mod file.0 - args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - file_id: ID of the file for which a URL should be returned. - user_data: User data to be returned with the result. - - requestFileInfo: - __doc__: - args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - file_id: ID of the file for which information is requested. - user_data: User data to be returned with the result. - - requestFiles: - __doc__: Request the list of files belonging to a mod. - args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - user_data: User data to be returned with the result. - - requestToggleEndorsement: - __doc__: - args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - mod_version: Version of the mod. - endorse: - user_data: User data to be returned with the result. - - IOrganizer: - __doc__: | - Interface to class that provides information about the running session - of Mod Organizer to be used by plugins. - - appVersion: - returns: The running version of Mod Organizer. - - basePath: - returns: The absolute path to the base directory of Mod Organizer. - - createMod: - __doc__: | - Create a new mod with the specified name. - - If a mod with the same name already exists, the user will be queried. If the user chooses - to merge or replace, the call will succeed, otheriwse the call will fail. - args: - name: Name of the mod to create. - returns: | - An interface to the newly created mod that can be used to modify it, or `None` if the mod - could not be created. - - createNexusBridge: - __doc__: Create a new Nexus interface. - returns: The newly created Nexus interface. - - downloadManager: - returns: The interface to the download manager. - - downloadsPath: - returns: The absolute path to the download directory. - - findFileInfos: - __doc__: Find files in the virtual directory matching the specified filter. - args: - path: The path to search in (relative to the 'data' folder). - filter: The function to use to filter files. Should return True for the files to keep. - returns: The list of `QFileInfo` corresponding to the matching files. - - findFiles.1: - __doc__: Find files in the given folder that matches the given filter. - args: - path: The path to search in (relative to the 'data' folder). - filter: The function to use to filter files. Should return True for the files to keep. - returns: The list of matching files. - - findFiles.2: - __doc__: Find files in the given folder that matches one of the given glob patterns. - args: - path: The path to search in (relative to the 'data' folder). - patterns: List of glob patterns to match against. - returns: The list of matching files. - - findFiles.3: - __doc__: Find files in the given folder that matches the given glob pattern. - args: - path: The path to search in (relative to the 'data' folder). - pattern: The glob pattern to use to filter files. - returns: The list of matching files. - - getFileOrigins: - __doc__: | - Retrieve the file origins for the speicified file. - - The origins are listed with their internal name. The internal name of a mod can differ - from the display name for disambiguation. - args: - filename: Path to the file to retrieve origins for (relative to the 'data' folder). - returns: The list of origins that contain the specified file, sorted by their priority. - - getGame: - __doc__: Retrieve the game plugin matching the given name. - args: - name: Name of the game (short name). - returns: The plugin for the given game, or `None` if none was found. - - getMod: - __doc__: Retrieve an interface to a mod using its name. - args: - name: Name of the mod to retrieve. - returns: An interface to the given mod, or `None` if there is no mod with this name - - installMod: - __doc__: Install a mod archive at the specified location. - args: - filename: Absolute filepath to the archive to install. - name_suggestion: Suggested name for this mod. This can still be changed by the user. - returns: An interface to the new installed mod, or `None` if no installation took place (canceled or failure). - - listDirectories: - __doc__: Retrieve the list of (virtual) subdirectories in the given path. - args: - directory: Path to the directory to list (relative to the 'data' folder). - returns: The list of directories in the given directory. - - managedGame: - returns: The plugin corresponding to the current game. - - modDataChanged: - __doc__: Notify the organizer that the given mod has changed. - args: - mod: The mod that has changed. - - modList: - returns: The interface to the mod list. - - modsPath: - returns: The (absolute) path to the mods directory. - - modsSortedByProfilePriority: - returns: The list of mod (names), sorted according to the current profile priorities. - - onAboutToRun: - __doc__: | - Install a new handler to be called when an application is about to run. - - Multiple handlers can be installed. If any of the handler returns `False`, the application will - not run. - args: - callback: | - The function to call when an application is about to run. The parameter is the absolute path - to the application to run. The function can return False to prevent the application from running. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onFinishedRun: - __doc__: Install a new handler to be called when an application has finished running. - args: - callback: | - The function to call when an application has finished running. The first parameter is the absolute - path to the application, and the second parameter is the exit code of the application. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onModInstalled: - __doc__: Install a new handler to be called when a new mod is installed. - args: - callback: | - The function to call when a mod is installed. The parameter of the function is the name of the - installed mod. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onPluginSettingChanged: - __doc__: Install a new handler to be called when a plugin setting is changed. - args: - callback: | - The function to call when a plugin setting is changed. The parameters are: The name of the plugin, the - name of the setting, the old value (or `None` if the setting did not exist before) and the new value - of the setting (or `None` if the setting has been removed). - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onProfileChanged: - __doc__: | - Install a new handler to be called when the current profile is changed. - - The function is called when the profile is changed but some operations related to - the profile might not be finished when this is called (e.g., the virtual file system - might not be up-to-date). - args: - callback: | - The function to call when the current profile is changed. The first parameter is the old profile (can - be `None`, e.g. at startup), and the second parameter is the new profile (cannot be `None`). - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onUserInterfaceInitialized: - __doc__: Install a new handler to be called when the UI has been fully initialized. - args: - callback: | - The function to call when the user-interface has been fully initialized. The parameter is the main - window of the application (`QMainWindow`). - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - overwritePath: - returns: The (absolute) path to the overwrite directory. - - persistent: - __doc__: | - Retrieve the specified persistent value for a plugin. - - A persistent is an arbitrary value that the plugin can set and retrieve that is persistently stored - by the main application. There is no UI for the user to change this value but they can directly access - the storage - args: - plugin_name: | - Name of the plugin for which to retrieve the value. This should always be IPlugin::name() unless you have a - really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - default: Default value to return if the key is not set (yet). - returns: The value corresponding to the given persistent setting, or `def` is the key is not found. - - pluginDataPath: - __doc__: | - Retrieve the path to a directory where plugin data should be stored. - - For python plugins, it is recommended to use a dedicated folder (per plugin) if you need to - store data (resources, or multiple python files). - returns: Path to a directory where plugin data should be stored. - - pluginList: - returns: The plugin list interface. - - pluginSetting: - __doc__: Retrieve settings of plugins. - args: - plugin_name: Name of the plugin to retrieve the setting for. - key: Name of the setting to retrieve the value for. - returns: The value of the setting. - - profile: - returns: The interface to the current profile. - - profileName: - returns: The name of the current profile, or an empty string if no profile has been loaded (yet). - - profilePath: - returns: The absolute path to the active profile or an empty string if no profile has been loaded (yet). - - refreshModList: - __doc__: Refresh the mod list. - args: - save_changes: If True, the relevant profile information is saved first (enabled mods and order of mods). - - removeMod: - __doc__: Remove a mod (from disc and from the UI). - args: - mod: The mod to remove. - returns: True if the mod was removed, False otherwise. - - resolvePath: - __doc__: Resolves a path relative to the virtual data directory to its absolute real path. - args: - filename: Path to resolve. - returns: The absolute real path, or an empty string if the path was not found. - - setPersistent: - __doc__: | - Set the specified persistent value for a plugin. - - This does not update the in-memory value for this setting, see `setPluginSetting()` for this. - args: - plugin_name: | - Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a - really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - value: New value for the setting. - sync: If True, the storage is immediately written to disc. This costs performance but is safer against data loss. - - setPluginSetting: - __doc__: | - Set the specified setting for a plugin. - - This automatically notify handlers register with `onPluginSettingChanged`, so you do not have to do it yourself. - args: - plugin_name: | - Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a - really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - value: New value for the setting. - - startApplication: - __doc__: Starts an application with virtual filesystem active. - args: - executable: | - Name or path of the executable. If this is only a filename, it will only work if it has been configured - in MO as an executable. If it is a relative path it is expected to be relative to the game directory. - args: | - Arguments to pass to the executable. If the list is empty, and `executable` refers to a configured executable, - the configured arguments are used. - cwd: | - The working directory for the executable. If this is empty, the path to the executable is used unless `executable` - referred to a configured MO executable, in which case the configured cwd is used. - profile: Profile to use. If this is empty (the default) the current profile is used. - forcedCustomOverwrite: The mod to set as the custom overwrite, regardless of what the profile has configured. - ignoreCustomOverwrite: Set to true to ignore the profile's configured custom overwrite. - returns: The handle to the started application, or 0 if the application failed to start. - - waitForApplication: - __doc__: | - Wait for the application corresponding to the given handle to finish. - - This will always show the lock overlay, regardless of whether the - user has disabled locking in the setting, so use this with care. - Note that the lock overlay will always allow the user to unlock, in - which case this will return False. - args: - handle: Handle of the application to wait for (as returned by `startApplication()`). - returns: | - A tuple `(result, exitcode)`, where `result` is a boolean indicating if the application - completed successfully, and `exitcode` is the exit code of the application. - - IPlugin: - __doc__: Base class for all plugins. - - __abstract__: true - - author: - returns: The name of the plugin author. - - description: - returns: The description for this plugin. - - init: - __doc__: Initialize this plugin. - args: - organizer: The main organizer interface. - returns: True if the plugin was initialized correctly, False otherwise. - - isActive: - __doc__: | - Check if this plugin is active. - - It is possible to use a plugin setting (specified in `settings()`) here to allow - users to manually enable/disable a plugin. - returns: True if this plugin is active, False otherwise. - - name: - __doc__: | - Retrieve the name of the plugin. - - The name of the plugin is used for internal storage purpose so it should not change, - and it should be static. In particular, you should not use a localized string (`tr()`) - for the plugin name. - - In the future, we will provide a way to localized plugin names using a distinct method, - such as `localizedName()`. - returns: The name of the plugin. - - settings: - returns: A list of settings for this plugin. - - version: - returns: The version of this plugin. - - IPluginDiagnose: - __doc__: | - Plugins that create problem reports to be displayed in the UI. - - This can be used to report problems related to the same plugin (which implements further - interfaces) or as a stand-alone diagnosis tool. - - _invalidate: - __doc__: Invalidate the problems corresponding to this plugin. - abstract: false - - activeProblems: - __doc__: | - Retrieve the list of active problems found by this plugin. - - This method returns a list of problem IDs, that are then used when calling other methods - such as `shortDescription()` or `hasGuidedFix()`. - returns: The list of active problems for this plugin. - - fullDescription: - __doc__: Retrieve the full description of the problem corresponding to the given key. - args: - key: ID of the problem. - returns: The full description of the problem. - raises: - IndexError: If the key is not valid. - - hasGuidedFix: - __doc__: Check if the problem corresponding to the given key has a guided fix. - args: - key: ID of the problem. - returns: True if there is a guided fix for the problem, False otherwise. - raises: - IndexError: If the key is not valid. - - shortDescription: - __doc__: Retrieve the short description of the problem corresponding to the given key. - args: - key: ID of the problem. - returns: The short description of the problem. - raises: - IndexError: If the key is not valid. - - startGuidedFix: - __doc__: | - Starts a guided fix for the problem corresponding to the given key. - - This method should throw `ValueError` if there is no guided fix for the corresponding - problem. - args: - key: ID of the problem. - raises: - IndexError: If the key is not valid. - ValueError: If there is no guided fix for this problem. - - IPluginFileMapper: - __doc__: Plugins that adds virtual file links. - - mappings: - returns: Mapping for the virtual file system (VFS). - - IPluginGame: - __doc__: | - Base classes for game plugins. - - Each game requires a specific game plugin. These plugins were initially designed for - Bethesda games, so a lot of methods and attributes are irrelevant for other games. If - you wish to write a plugin for a much simpler game, please consider the `basic_games` - plugin: https://github.com/ModOrganizer2/modorganizer-basic_games - - CCPlugins: - returns: The current list of active Creation Club plugins. - - DLCPlugins: - returns: The list of esp/esm files that are part of known DLCs. - - binaryName: - returns: The name of the default executable to run (relative to the game folder). - - dataDirectory: - returns: The name of the directory containing data (relative to the game folder). - - documentsDirectory: - returns: The directory of the documents folder where configuration files and such for this game reside. - - executableForcedLoads: - returns: A list of automatically discovered libraries that can be force loaded with executables. - - executables: - returns: A list of automatically discovered executables of the game itself and tools surrounding it. - - feature: - __doc__: Retrieve a specified game feature from this plugin. - abstract: false - args: - feature_type: - __doc__: The class of feature to retrieve. - type: Type[GameFeatureType] - returns: - __doc__: | - The game feature corresponding to the given type, or `None` if the feature is - not implemented. - type: GameFeatureType - - featureList: - __doc__: | - Retrieve the list of game features implemented for this plugin. - - Python plugin should not implement this method but `_featureList()`. - abstract: false - returns: - __doc__: A mapping from feature type to actual game features. - type: Dict[Type[GameFeatureType], GameFeatureType] - - gameDirectory: - returns: The directory containing the game installation. - - gameIcon: - returns: The icon representing the game. - - gameName: - returns: The name of the game (as displayed to the user). - - gameNexusName: - returns: The name of the game identifier for Nexus. - - gameShortName: - returns: The short name of the game. - - gameVariants: - __doc__: | - Retrieve the list of variants for this game. - - If there are multiple variants of a game (and the variants make a difference to the - plugin), like a regular one and a GOTY-edition, the plugin can return a list of them - and the user gets to chose which one he owns. - returns: The list of variants of the game. - - gameVersion: - returns: The version of the game. - - getLauncherName: - returns: | - The name of the launcher executable to run (relative to the game folder), or an - empty string if there is no launcher. - - iniFiles: - returns: | - The list of INI files this game uses. The first file in the list should be the - 'main' INI file. - - initializeProfile: - __doc__: | - Initialize a profile for this game. - - The MO app does not yet support virtualizing only specific aspects but plugins should be written - with this future functionality in mind. - - This function will be used to initially create a profile, potentially to repair it or upgrade/downgrade - it so the implementations have to gracefully handle the case that the directory already contains files. - args: - directory: The directory where the profile is to be initialized. - settings: The parameters for how the profile should be initialized. - - isInstalled: - returns: True if this game has been discovered as installed, False otherwise. - - loadOrderMechanism: - returns: The load order mechanism used by this game. - - looksValid: - __doc__: Check if the given directory looks like a valid game installation. - args: - directory: Directory to check. - returns: True if the directory looks like a valid installation of this game, False otherwise. - - nexusGameID: - __doc__: | - Retrieve the Nexus game ID for this game. - - Example: For Skyrim, the Nexus game ID is 110. - returns: The Nexus game ID for this game. - - nexusModOrganizerID: - __doc__: | - Retrieve the Nexus mod ID of Mod Organizer for this game. - - Example: For Skyrim SE, the mod ID of MO2 is 6194. You can find the mod ID in the URL: - https://www.nexusmods.com/skyrimspecialedition/mods/6194 - returns: The Nexus mod ID of Mod Organizer for this game. - - primaryPlugins: - returns: The list of plugins that are part of the game and not considered optional. - - primarySources: - __doc__: | - Retrieve primary alternative 'short' names for this game. - - This is used to determine if a Nexus (or other) download source should be considered - as a primary source for the game so that it is not flagged as an alternative one. - returns: The list of primary alternative 'short' names for this game, or an empty list. - - savegameExtension: - __doc__: - returns: The file extension of save games for this game. - - savegameSEExtension: - returns: The file extension of Script Extender saves for this game. - - savesDirectory: - returns: The directory where save games are stored. - - setGamePath: - __doc__: | - Set the path to the managed game. - - This is called during instance creation if the game is not auto-detected and the user has - to specify the installation location. This is not called if the game has been auto-detected, - so `isInstalled()` should call this. - args: - path: Path to the game installation. - - setGameVariant: - __doc__: | - Set the game variant. - - If there are multiple variants of game (as returned by `gameVariants()`), this will be - called on start with the user-selected game variant. - args: - variant: The game variant selected by the user. - - sortMechanism: - returns: The sort mechanism for this game. - - steamAPPId: - __doc__: | - Retrieve the Steam app ID for this game. - - If the game is not available on Steam, this should return an empty string. - - If a game is available in multiple versions, those might have different app ids. The plugin - should try to return the right one - returns: The Steam app ID for this game. Should be empty for games not available on steam. - - validShortNames: - __doc__: | - Retrieve the valid 'short' names for this game. - - This is used to determine if a Nexus download is valid for the current game since not all - game variants have their own nexus pages and others can handle downloads from other nexus - game pages and should be allowed to do so (e.g., you can install some Skyrim LE mod even - when using Skyrim SE). - - The short name should be considered the primary handler for a directly supported game - for puroses of auto-launching an instance. - returns: The list of valid short names for this game. - - IPluginInstaller: - __doc__: | - This is the top-level class for installer. Actual installers should inherit either: - - - `IPluginInstallerSimple` if the installer can work directly with the archive. This is what - most installers use. - - `IPluginInstallerCustom` if the installer needs to perform custom operations. This is only - used by the external NCC installer and the OMOD installer. - - isArchiveSupported: - __doc__: Check if the given file tree corresponds to a supported archive for this installer. - args: - tree: The tree representing the content of the archive. - returns: True if this installer can handle the archive, False otherwise. - - isManualInstaller: - __doc__: Check if this installer is a manual installer. - returns: True if this installer is a manual installer, False otherwise. - - priority: - __doc__: | - Retrieve the priority of this installer. - - If multiple installers are able to handle an archive, the one with the highest priority wins. - returns: The priority of this installer. - - setInstallationManager: - __doc__: | - Set the installation manager for this installer. - - Python plugins usually do not need to re-implement this and can directly access the installation - manager using `_manager()`. - abstract: false - args: - manager: The installation manager. - - setParentWidget: - __doc__: | - Set the parent widget for this installer. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - abstract: false - args: - parent: The parent widget. - - IPluginInstallerCustom: - __doc__: | - Custom installer for mods. Custom installers receive the archive name and have to go - from there. They have to be able to extract the archive themself. - - Example of such installers are the external NCC installer or the OMOD installer. - - _manager: - abstract: false - returns: The installation manager. - - _parentWidget: - abstract: false - returns: The parent widget. - - install: - __doc__: | - Install the given archive. - - The mod needs to be created by calling `IOrganizer.createMod` first. - args: - mod_name: | - Name of the mod to install. As an input parameter this is the suggested name - (e.g. from meta data) The installer may change this parameter to rename the mod). - game_name: Name of the game for which the mod is installed. - archive_name: Name of the archive to install. - version: | - Version of the mod. May be empty if the version is not yet known. The plugin is responsible - for setting the version on the created mod. - nexus_id: | - ID of the mod or -1 if unknown. The plugin is responsible for setting the mod ID for the - created mod. - returns: The result of the installation process. - - isArchiveSupported.1: - __doc__: Check if the given file tree corresponds to a supported archive for this installer. - args: - tree: The tree representing the content of the archive. - returns: True if this installer can handle the archive, False otherwise. - - isArchiveSupported.2: - __doc__: Check if the given file is a supported archive for this installer. - args: - archive_name: Name of the archive. - returns: True if this installer can handle the archive, False otherwise. - - supportedExtensions: - returns: A list of file extensions that this installer can handle. - - IPluginInstallerSimple: - __doc__: | - Simple installer for mods. Simple installers only deal with an in-memory structure - representing the archive and can modify what to install and where by editing this structure. - Actually extracting the archive is handled by the manager. - - _manager: - abstract: false - returns: The installation manager. - - _parentWidget: - abstract: false - returns: The parent widget. - - install: - __doc__: | - Install a mod from an archive filetree. - - The installer can modify the given tree and use the manager to extract or create new - files. - - This method returns different type of objects depending on the actual result of the - installation. The C++ bindings for this method always returns a tuple (result, tree, - version, id). - args: - name: | - Name of the mod to install. As an input parameter this is the suggested name - (e.g. from meta data) The installer may change this parameter to rename the mod). - tree: In-memory representation of the archive content. - version: Version of the mod, or an empty string is unknown. - nexus_id: ID of the mod, or -1 if unknown. - returns: | - In case of failure, the result of the installation, otherwise the modified tree or - a tuple (result, tree, version, id) containing the result of the installation, the - modified tree, the new version and the new ID. The tuple can be returned even if the - installation did not succeed. - - IPluginList: - - __doc__: Primary interface to the list of plugins. - - isMaster: - __doc__: | - Check if a plugin is a master file (basically a library, referenced by other plugins). - - In gamebryo games, a master file will usually have a .esm file extension but technically - an esp can be flagged as master and an esm might not be. - args: - name: Filename of the plugin (without path but with file extension). - returns: True if the given plugin is a master plugin, False otherwise or if the file does not exist. - - loadOrder: - __doc__: Retrieve the load order of a plugin. - args: - name: Filename of the plugin (without path but with file extension). - returns: | - The load order of the plugin (the order in which the game loads it). If all plugins are enabled this - is the same as the priority but disabled plugins will have a load order of -1. This also returns -1 - if the plugin does not exist. - - masters: - __doc__: Retrieve the list of masters required for a plugin. - args: - name: Filename of the plugin (without path but with file extension). - returns: The list of masters for the plugin (filenames with extension, no path). - - onPluginMoved: - __doc__: Install a new handler to be called when a plugin is moved. - args: - callback: | - The function to call when a plugin is moved. The first parameter is the plugin name, the - second the old priority of the plugin and the third one the new priority. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onRefreshed: - __doc__: Install a new handler to be called when the list of plugins is refreshed. - args: - callback: The function to call when the list of plugins is refreshed. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - origin: - __doc__: | - Retrieve the origin of a plugin. This is either the (internal) name of a mod, `"overwrite"` or `"data"`. - - The internal name of a mod can differ from the display name for disambiguation. - args: - name: Filename of the plugin (without path but with file extension). - returns: The name of the origin of the plugin, or an empty string if the plugin does not exist. - - pluginNames: - returns: The list of all plugin names. - - priority: - __doc__: | - Retrieve the priority of a plugin. - - The higher the priority, the more important. - args: - name: Filename of the plugin (without path but with file extension). - returns: The priority of the given plugin, or -1 if the plugin does not exist. - - setLoadOrder: - __doc__: | - Set the load order. - - Plugins not included in the list will be placed at highest priority in the order they - were before. - args: - loadorder: The new load order, specified by the list of plugin names, sorted. - - setState: - __doc__: Set the state of a plugin. - args: - name: Filename of the plugin (without path but with file extension). - state: New state of the plugin (`INACTIVE` or `ACTIVE`). - - state: - __doc__: Retrieve the state of a plugin. - args: - name: Filename of the plugin (without path but with file extension). - returns: The state of the plugin. - - IPluginModPage: - - _parentWidget: - abstract: false - returns: The parent widget. - - displayName: - returns: The name of the page as displayed in the UI. - - handlesDownload: - __doc__: Check if the plugin handles the specified download. - args: - page_url: URL of the page that contains the download link. - download_url: The download URL. - fileinfo: Not usable in python. - returns: True if this plugin wants to handle the specified download, False otherwise. - - icon: - returns: The icon to display with the page. - - pageURL: - returns: The URL to open when the user wants to visit this mod page. - - setParentWidget: - __doc__: | - Set the parent widget for this mod page. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - abstract: false - args: - parent: The parent widget. - - useIntegratedBrowser: - __doc__: | - Indicates if the page should be displayed in the integrated browser. - - Unless the page provides a special means of starting downloads (like the nxm:// url schema - on nexus), it will not be possible to handle downloads unless the integrated browser is used! - returns: True if the page should be opened in the integrated browser, False otherwise. - - IPluginPreview: - __doc__: | - These plugins add support for previewing files in the data pane. Right now all image formats supported - by qt are implemented (including dds) but no audio files and no 3d mesh formats. - - genFilePreview: - __doc__: Generate a preview for the specified file. - args: - filename: Path to the file to preview. - max_size: Maximum size of the generated widget. - returns: The widget showing a preview of the file. - - supportedExtensions: - returns: The list of file extensions that are supported by this preview plugin. - - IPluginTool: - __doc__: | - This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools submenu - and get invoked when the user clicks it. They are expected to have a user interface of some sort. These - are almost like independent applications except they can access all Mod Organizer interfaces like querying - and modifying the current profile, mod list, load order, use MO to install mods and so on. A tool plugin - can (and should!) integrate its UI as a window inside MO and thus doesn't have to initialize a windows - application itself. - - _parentWidget: - abstract: false - returns: The parent widget. - - display: - __doc__: Called when the user starts the tool. - - displayName: - returns: The display name for this tool, as shown in the tool menu. - - icon: - returns: The icon for this tool, or a default-constructed QICon(). - - setParentWidget: - __doc__: | - Set the parent widget for this tool. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - abstract: false - args: - parent: The parent widget. - - tooltip: - returns: The tooltip for this tool. - - IProfile: - __doc__: - absolutePath: - __doc__: - returns: - invalidationActive: - __doc__: - returns: - localSavesEnabled: - __doc__: - returns: - localSettingsEnabled: - __doc__: - returns: - name: - __doc__: - returns: - - ISaveGame: - __doc__: Base class for information about what is in a save game. - - allFiles: - returns: The list of all files related to this save. - - getCreationTime: - __doc__: | - Retrieve the creation time of the save. - - The creation time of a save is not always the same as the creation time of - the file containing the save. - returns: The creation time of the save. - - getFilename: - returns: The name of the (main) save file. - - getSaveGroupIdentifier: - __doc__: | - Retrieve the name of the group this files belong to. - - The name can be used to identify sets of saves to transfer between profiles. For - RPG games, this is usually the name of a character. - returns: The group identifier for this save game. - - hasScriptExtenderFile: - returns: True if this save game has an associated script extender save, False otherwise. - - ISaveGameInfoWidget: - __doc__: Base class for a save game info widget. - # Class not abstract because it conflicts with Qt metaclass: - # __abstract__: true - __init__: - args: - parent: Parent widget. - _widget: - returns: The underlying `QWidget`. - setSave: - abstract: true - __doc__: Set the save file to display in this widget. - args: - save: Path to the save file. - - LocalSavegames: - __doc__: - __abstract__: true - __init__: - __doc__: - mappings: - __doc__: - args: - profile_save_dir: - returns: - prepareProfile: - __doc__: - args: - profile: - returns: - - Mapping: - - __init__: - __doc__: Creates an empty Mapping. - - properties[]: - createTarget: - type: bool - desc: True if file creation (including move or copy) should be redirected to source. - destination: - type: str - desc: The destination of this mapping (absolute path). - isDirectory: - type: bool - desc: True if this mapping corresponds to a directory, False otherwise. - source: - type: str - desc: The source of this mapping (absolute path). - - ModDataChecker: - __doc__: Game feature that is used to check the content of a data tree. - - __abstract__: true - - CheckReturn: - __doc__: - INVALID: The data tree looks invalid and cannot be fixed (automatically). - FIXABLE: The data tree looks valid. - VALID: The data tree looks invalid but can be automatically fixed. - - __init__: - __doc__: - - dataLooksValid: - __doc__: | - Check that the given filetree represent a valid mod layout, or can be easily - fixed. - - This method is mainly used during installation (to find which installer should - be used or to recurse into multi-level archives), or to quickly indicates to a - user if a mod looks valid. - - This method does not have to be exact, it only has to indicate if the given tree - looks like a valid mod or not by quickly checking the structure (heavy operations - should be avoided). - - If the tree can be fixed by the `fix()` method, this method should return `FIXABLE`. - `FIXABLE` should only be returned when it is guaranteed that `fix()` can fix the tree. - args: - filetree: The tree starting at the root of the "data" folder. - returns: Whether the tree is invalid, fixable or valid. - - fix: - __doc__: | - Try to fix the given tree. - - This method is used during installation to try to fix invalid archives and will only be - called if dataLooksValid returned `FIXABLE`. - abstract: false - args: - filetree: The tree to try to fix. Can be modified during the process. - returns: - __doc__: The fixed tree, or a null pointer if the tree could not be fixed. - type: Optional["IFileTree"] - - ModDataContent: - __doc__: | - The ModDataContent feature is used (when available) to indicate to users the content - of mods in the "Content" column. - - The feature exposes a list of possible content types, each associated with an ID, a name - and an icon. The icon is the path to either: - - - A Qt resource or; - - A file on the disk. - - In order to facilitate the implementation, MO2 already provides a set of icons that can - be used. Those icons are all under ``:/MO/gui/content`` (e.g. ``:/MO/gui/content/plugin`` or ``:/MO/gui/content/music`` `). - - The list of available icons is: - - - ``plugin``: |plugin-icon| - - ``skyproc``: |skyproc-icon| - - ``texture``: |texture-icon| - - ``music``: |music-icon| - - ``sound``: |sound-icon| - - ``interface``: |interface-icon| - - ``skse``: |skse-icon| - - ``script``: |script-icon| - - ``mesh``: |mesh-icon| - - ``string``: |string-icon| - - ``bsa``: |bsa-icon| - - ``menu``: |menu-icon| - - ``inifile``: |inifile-icon| - - ``modgroup``: |modgroup-icon| - - .. |plugin-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/jigsaw-piece.png - .. |skyproc-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/hand-of-god.png - .. |texture-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/empty-chessboard.png - .. |music-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/double-quaver.png - .. |sound-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/lyre.png - .. |interface-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/usable.png - .. |skse-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/checkbox-tree.png - .. |script-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/tinker.png - .. |mesh-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/breastplate.png - .. |string-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/conversation.png - .. |bsa-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/locked-chest.png - .. |menu-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/config.png - .. |inifile-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/feather-and-scroll.png - .. |modgroup-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/xedit.png - - __abstract__: true - - Content: - __doc__: - - __init__: - __doc__: - - args: - id: ID of this content. - name: Name of this content. - icon: | - Path to the icon for this content. Can be either a path - to an image on the disk, or to a resource. Can be an empty string if filterOnly - is true. - filter_only: | - Indicates if the content should only be show in the filter - criteria and not in the actual Content column. - - isOnlyForFilter: - __doc__: - returns: True if this content is only meant to be used as a filter criteria. - - properties[]: - id: - type: int - desc: The ID of this content. - name: - type: str - desc: The name of this content. - icon: - type: str - desc: The path to the icon of this content (can be a Qt resource path). - - __init__: - __doc__: - - getAllContents: - __doc__: - returns: The list of all possible contents for the corresponding game. - - getContentsFor: - __doc__: Retrieve the list of contents in the given tree. - args: - filetree: The tree corresponding to the mod to retrieve contents for. - returns: The IDs of the content in the given tree. - - ModRepositoryFileInfo: - __doc__: - properties[]: - categoryID: - type: int - desc: - description: - type: str - desc: - fileCategory: - type: int - desc: - fileID: - type: int - desc: - fileName: - type: str - desc: - fileSize: - type: int - desc: - fileTime: - type: PyQt5.QtCore.QDateTime - desc: - gameName: - type: str - desc: - modID: - type: int - desc: - modName: - type: str - desc: - name: - type: str - desc: - newestVersion: - type: VersionInfo - desc: - repository: - type: str - desc: - uri: - type: str - desc: - userData: - type: MoVariant - desc: - version: - type: VersionInfo - desc: - - __init__.1: - __doc__: - args: - other: - __init__.2: - __doc__: - args: - game_name: - mod_id: - file_id: - __str__: - __doc__: - returns: - createFromJson: - __doc__: - args: - data: - returns: - - PluginSetting: - __doc__: | - Class to hold the user-configurable parameters a plugin accepts. The purpose of this class is - only to inform the application what settings to offer to the user, it does not hold the actual value. - properties[]: - default_value: - type: MoVariant - desc: Default value of the setting. - description: - type: str - desc: Description of the setting. - key: - type: str - desc: Name of the setting. - - __init__: - __doc__: - args: - key: Name of the setting. - description: Description of the setting. - default_value: Default value of the setting. - - SaveGameInfo: - __doc__: Feature to get hold of stuff to do with save games. - __abstract__: true - __init__: - __doc__: - - getMissingAssets: - __doc__: Retrieve missing assets from the save. - args: - filepath: Path to the save file. - returns: | - A collection of missing assets and the modules that can supply those assets. - - getSaveGameInfo: - __doc__: Retrieve the information about the supplied save game. - args: - filepath: Path to the save file. - returns: A SaveGame corresponding to the given save file. - - getSaveGameWidget: - __doc__: | - Retrieve a widget to display over the save game list. - - This method is allowed to return `None` in case no widget has been implemented. - args: - parent: The parent widget. - returns: - __doc__: A SaveGameInfoWidget to display information about save game. - type: Optional["ISaveGameInfoWidget"] - - hasScriptExtenderSave: - __doc__: Check whether or not the save has a paired script extender save. - args: - filepath: Path to the save file. - returns: | - True if the given save file has a paired script extender save, False otherwise. - - ScriptExtender: - __doc__: - __abstract__: true - - BinaryName: - __doc__: - returns: The name of the script extender binary. - - PluginPath: - __doc__: - returns: The script extender plugin path, relative to the data folder. - - getArch: - __doc__: - returns: The CPU platform of the extender. - - getExtenderVersion: - __doc__: - returns: The version of the script extender. - - isInstalled: - __doc__: - returns: True if the script extender is installed, False otherwise. - - loaderName: - __doc__: - returns: The loader to use to ensure the game runs with the script extender. - - loaderPath: - __doc__: - returns: The fullpath to the script extender loader. - - # TODO: Remove this? Deprecated? - saveGameAttachmentExtensions: - __doc__: - returns: Additional savegame attachments. - - UnmanagedMods: - __doc__: - __abstract__: true - - displayName: - __doc__: Retrieve the display name of a given mod. - args: - mod_name: Internal name of the mod. - returns: The display name of the mod. - - mods: - __doc__: Retrieve the list of unmanaged mods for the corresponding game. - args: - official_only: Retrieve only unmanaged official mods. - returns: The list of unmanaged mods (internal names). - - referenceFile: - __doc__: | - Retrieve the reference file for the requested mod. - - Example: For Bethesda games, the reference file may be the main - plugin (esp or esm) for the game or a DLCs. - args: - mod_name: Internal name of the mod. - returns: The reference file (absolute path) for the requested mod. - - secondaryFiles: - __doc__: | - Retrieve the secondary files for the requested mod. - - Example: For Bethesda games, the secondary files may be the archives - corresponding to the reference file. - args: - mod_name: Internal name of the mod. - returns: The secondary files (absolute paths) for the request mod. - - VersionInfo: - __doc__: Represents the version of a mod or plugin. - - __init__.1: Construct an invalid VersionInfo. - - __init__.2: - __doc__: Construct a VersionInfo by parsing the given string according to the given scheme. - - args: - value: String to parse. - scheme: Scheme to use to parse the string. - - __init__.3: - __doc__: Construct a VersionInfo using the given elements. - - args: - major: Major version. - minor: Minor version. - subminor: Subminor version. - subsubminor: Subsubminor version. - release_type: Type of release. - - __init__.4: - __doc__: Construct a VersionInfo using the given elements. - - args: - major: Major version. - minor: Minor version. - subminor: Subminor version. - release_type: Type of release. - - __str__: - returns: > - See `canonicalString()`. - - canonicalString: - returns: > - A canonical string representing this version, that can be stored and then parsed using - the parse() method. - - clear: Resets this VersionInfo to an invalid version. - - displayString: - args: - forced_segments: | - The number of version segments to display even if the version is 0. 1 is major, 2 is major - and minor, etc. The only implemented ranges are (-inf,2] for major/minor, [3] for major/minor/subminor, - and [4,inf) for major/minor/subminor/subsubminor. This only versions with a regular scheme. - returns: > - A string for display to the user. The returned string may not contain enough information - to reconstruct this version info. - - isValid: - returns: True if this VersionInfo is valid, False otherwise. - - parse: - __doc__: Update this VersionInfo by parsing the given string using the given scheme. - - args: - value: String to parse. - scheme: Scheme to use to parse the string. - manual_input: True if the given string should be treated as user input. - - scheme: - returns: The version scheme in effect for this VersionInfo. diff --git a/configs/config-2.4.yml b/configs/config-2.4.yml deleted file mode 100644 index b181ad5..0000000 --- a/configs/config-2.4.yml +++ /dev/null @@ -1,2855 +0,0 @@ ---- -version: 1 - -# This is the list of type to replace: -replacements: - Organizer::FileInfo: FileInfo - IOrganizer::FileInfo: FileInfo - IPluginInstaller::EInstallResult: InstallResult - -# List of names to ignores: -ignores: - - toPyQt - -# This is the root of the mobase module and will contain everything -# related to functions / classes, including their documentation. -mobase: - - # Version of the stubs. - __version__: 2.4.0.alpha1 - - getFileVersion: - __doc__: Retrieve the file version of the given executable. - args: - filepath: Absolute path to the executable. - returns: | - The file version, or an empty string if the file version could not be retrieved. - - getIconForExecutable: - __doc__: Retrieve the icon of an executable. Currently this always extracts the biggest icon. - args: - executable: Absolute path to the executable. - returns: The icon for this executable, if any. - - getProductVersion: - __doc__: Retrieve the product version of the given executable. - args: - executable: Absolute path to the executable. - returns: | - The product version, or an empty string if the product version could not be retrieved. - - EndorsedState: - ENDORSED_TRUE: - ENDORSED_FALSE: - ENDORSED_UNKNOWN: - ENDORSED_NEVER: - - TrackedState: - TRACKED_FALSE: - TRACKED_TRUE: - TRACKED_UNKNOWN: - - GuessQuality: - __doc__: | - Describes how good the code considers a guess (i.e. for a mod name) this is used to - determine if a name from another source should overwrite or not. - - INVALID: No valid value has been set yet. - FALLBACK: The guess is very basic and should only be used if no other source is available. - GOOD: Considered a good guess. - META: The value comes from metadata and is usually what the author intended. - PRESET: | - The value comes from a previous installation of the same data/mod and usually represents - what the user chose before. - USER: The user selection, always overrules other sources. - - InstallResult: - __doc__: - SUCCESS: - FAILED: - CANCELED: - MANUAL_REQUESTED: - NOT_ATTEMPTED: - - LoadOrderMechanism: - __doc__: - FILE_TIME: Order of plugins is determined by the filetime of the plugins. - PLUGINS_TXT: Order of plugins is determined by the plugins.txt file. - - ModState: - __doc__: - EXISTS: - ACTIVE: - ESSENTIAL: - EMPTY: - ENDORSED: - VALID: - ALTERNATE: - - PluginState: - __doc__: - MISSING: - INACTIVE: - ACTIVE: - - ProfileSetting: - __doc__: - MODS: - CONFIGURATION: - SAVEGAMES: - PREFER_DEFAULTS: - - ReleaseType: - __doc__: - PRE_ALPHA: - ALPHA: - BETA: - CANDIDATE: - FINAL: - - SortMechanism: - __doc__: - NONE: - MLOX: - BOSS: - LOOT: - - VersionScheme: - __doc__: - DISCOVER: - REGULAR: - DECIMAL_MARK: - NUMBERS_AND_LETTERS: - DATE: - LITERAL: - - # TODO: - BSAInvalidation: - __doc__: - __abstract__: true - __init__: - __doc__: - activate: - __doc__: - args: - profile: - deactivate: - __doc__: - args: - profile: - isInvalidationBSA: - __doc__: - args: - name: - returns: - - DataArchives: - __abstract__: true - - addArchive: - __doc__: Add an archive to the archive list. - args: - profile: Profile to add the archive to. - index: | - Index to insert before. Use 0 for the beginning of the list or INT_MAX for - the end of the list). - name: Name of the archive to add. - - archives: - __doc__: Retrieve the list of archives in the given profile. - args: - profile: Profile to retrieve archives from. - returns: The list of archives in the given profile. - - removeArchive: - __doc__: Remove the given archive from the given profile. - args: - profile: Profile to remove the archive from. - name: Name of the archive to remove. - - vanillaArchives: - __doc__: | - Retrieve the list of vanilla archives. - - Vanilla archives are archive files that are shipped with the original - game. - returns: The list of vanilla archives. - - ExecutableForcedLoadSetting: - __doc__: - __init__: - __doc__: - args: - process: - library: - enabled: - __doc__: - returns: - forced: - __doc__: - returns: - library: - __doc__: - returns: - process: - __doc__: - returns: - withEnabled: - __doc__: - args: - enabled: - returns: - withForced: - __doc__: - args: - forced: - returns: - - ExecutableInfo: - __doc__: - __init__: - __doc__: - args: - title: - binary: - arguments: - __doc__: - returns: - asCustom: - __doc__: - returns: - binary: - __doc__: - returns: - isCustom: - __doc__: - returns: - isValid: - __doc__: - returns: - steamAppID: - __doc__: - returns: - title: - __doc__: - returns: - withArgument: - __doc__: - args: - argument: - returns: - withSteamAppId: - __doc__: - args: - app_id: - returns: - withWorkingDirectory: - __doc__: - args: - directory: - returns: - workingDirectory: - __doc__: - returns: - - FileInfo: - __doc__: Information about a virtualised file - properties[]: - archive: - type: str - desc: | - Name of the archive if this file is in an archive (e.g. BSA), otherwise an - empty string. - filePath: - type: str - desc: Full path to the file. - origins: - type: List[str] - desc: | - List of origins containing providing this file. The first origin in the list - is the highest priority one (actually providing the file). - - __init__: - __doc__: Creates an uninitialized FileInfo. - - FileTreeEntry: - __doc__: | - Represent an entry in a file tree, either a file or a directory. This class - inherited by IFileTree so that operations on entry are the same for a file or - a directory. - - This class provides convenience methods to query information on the file, like its - name or the its last modification time. It also provides a convenience astree() method - that can be used to retrieve the tree corresponding to its entry in case the entry - represent a directory. - - FileTypes: - __doc__: Enumeration of the different file type or combinations. - DIRECTORY: - FILE: - FILE_OR_DIRECTORY: - - detach: - __doc__: Detach this entry from its parent tree. - returns: True if the entry was removed correctly, False otherwize. - - fileType: - returns: The filetype of this entry. - - hasSuffix.1: - __doc__: Check if this entry has one of the given suffixes. - args: - suffixes: Suffixes to check. - returns: True if this entry is a file and has one of the given suffix. - - hasSuffix.2: - __doc__: Check if this entry has the given suffix. - args: - suffix: Suffix to check. - returns: True if this entry is a file and has the given suffix. - - isDir: - returns: True if this entry is a directory, False otherwise. - - isFile: - returns: True if this entry is a file, False otherwise. - - moveTo: - __doc__: Move this entry to the given tree. - args: - tree: The tree to move this entry to. - returns: True if the entry was moved correctly, False otherwize. - - name: - returns: The name of this entry. - - parent: - returns: - __doc__: | - The parent tree containing this entry, or a `None` if this entry is the root - or the parent tree is unreachable. - type: Optional["IFileTree"] - - path: - __doc__: | - Retrieve the path from this entry up to the root of the tree. - - This method propagate up the tree so is not constant complexity as - the full path is never stored. - args: - sep: The type of separator to use to create the path. - returns: The path from this entry to the root, including the name of this entry. - - pathFrom: - __doc__: Retrieve the path from the given tree to this entry. - args: - tree: The tree to reach, must be a parent of this entry. - sep: The type of separator to use to create the path. - returns: | - The path from the given tree to this entry, including the name of this entry, or - an empty string if the given tree is not a parent of this entry. - - suffix: - __doc__: | - Retrieve the "last" extension of this entry. - - The "last" extension is everything after the last dot in the file name. - returns: | - The last extension of this entry, or an empty string if the file has no extension - or is directory. - - GamePlugins: - __abstract__: true - getLoadOrder: - __doc__: - returns: - lightPluginsAreSupported: - returns: True if light plugins are supported, False otherwise. - readPluginLists: - __doc__: - args: - plugin_list: - writePluginLists: - __doc__: - args: - plugin_list: - - GuessedString: - __doc__: | - Represents a string that may be set from different places. Each time the value is - changed a "quality" is specified to say how probable it is the value is the best choice. - Only the best choice should be used in the end but alternatives can be queried. This - class also allows a filter to be set. If a "guess" doesn't pass the filter, it is ignored. - - __init__.1: - __doc__: Creates a GuessedString with no associated value. - - __init__.2: - __doc__: Creates a GuessedString with the given value and quality. - args: - value: Initial value of the GuessedString. - quality: Quality of the initial value. - - reset.1: - __doc__: Reset this GuessedString to an invalid state. - returns: This GuessedString object. - - reset.2: - __doc__: | - Reset this GuessedString object with the given value and quality, only - if the given quality is better than the current one. - args: - value: New value for this GuessedString. - quality: Quality of the new value. - returns: This GuessedString object. - - reset.3: - __doc__: | - Reset this GuessedString object by copying the given one, only - if the given one has better quality. - args: - other: The GuessedString to copy. - returns: This GuessedString object. - - setFilter: - __doc__: | - Set the filter for this GuessedString. - - The filter is applied on every `update()` and can reject the new value - altogether or modify it (by returning a new value). - args: - filter: The new filter. - - update.1: - __doc__: | - Update this GuessedString by adding the given value to the list of variants - and setting the actual value without changing the current quality of this - GuessedString. - - The GuessedString is only updated if the given value passes the filter. - args: - value: The new value for this string. - returns: This GuessedString object. - - update.2: - __doc__: | - Update this GuessedString by adding a new variants with the given quality. - - If the specified quality is better than the current one, the actual value of - the GuessedString is also updated. - - The GuessedString is only updated if the given value passes the filter. - args: - value: The new variant to add. - quality: The quality of the variant. - returns: This GuessedString object. - - variants: - returns: The list of variants for this GuessedString. - - IDownloadManager: - __bases__: - - PyQt5.QtCore.QObject - - signals[]: - downloadComplete: - __doc__: Emitted when a download finishes completely (including retrieval of meta information). - args: - id: - type: int - desc: ID of the download. - downloadPaused: - __doc__: Emitted when a download is paused by the user. - args: - id: - type: int - desc: ID of the download. - downloadFailed: - __doc__: Emitted when a download fails. - args: - id: - type: int - desc: ID of the download. - downloadRemoved: - __doc__: Emitted when a download is removed from the manager. The ID of the download is no longer valid. - args: - id: - type: int - desc: ID of the download. - - _object: - returns: The underlying `QObject` for the manager. - - downloadPath: - __doc__: Retrieve the (absolute) path of the specified download. - args: - id: ID of the download. - returns: | - The absolute path to the file corresponding to the given download. This file - may not exist yet if the download is incomplete. - - startDownloadNexusFile: - __doc__: | - Download a file from www.nexusmods.com/. is always the game - currently being managed. - args: - mod_id: ID of the mod to download the file from. - file_id: ID of the file to download. - returns: An ID identifying the download. - - startDownloadURLs: - __doc__: | - Download a file by url. - - The list can contain alternative URLs to allow the download manager to switch - in case of download problems - args: - urls: List of urls to download from. - returns: An ID identifying the download. - - IFileTree: - __doc__: | - Interface to classes that provides way to visualize and alter file trees. The tree - may not correspond to an actual file tree on the disk (e.g., inside an archive, - from a QTree Widget, ...). - - Read-only operations on the tree are thread-safe, even when the tree has not been populated - yet. - - In order to prevent wrong usage of the tree, implementing classes may throw - UnsupportedOperationException if an operation is not supported. By default, all operations - are supported, but some may not make sense in many situations. - - The goal of this is not reflect the change made to a IFileTree to the disk, but child - classes may override relevant methods to do so. - - The tree is built upon FileTreeEntry. A given tree holds shared pointers to its entries - while each entry holds a weak pointer to its parent, this means that the descending link - are strong (shared pointers) but the uplink are weaks. - - Accessing the parent is always done by locking the weak pointer so that returned pointer - or either null or valid. This structure implies that as long as the initial root lives, - entry should not be destroyed, unless the entry are detached from the root and no shared - pointers are kept. - - However, it is not guarantee that one can go up the tree from a single node entry. If the - root node is destroyed, it will not be possible to go up the tree, even if we still have - a valid shared pointer. - - InsertPolicy: - __doc__: - FAIL_IF_EXISTS: Operation will fail if the destination already exists. - REPLACE: | - If the destination exists, it will be replaced (even if the source is a file and - the destination a directory). - MERGE: | - If the destination exists, and the source and destination are of the same type (e.g. - two files or two folders), a merge is performed: if both entries are files, the source - replaces the destination, otherwise the source is merged into the destination. If the - destination exists but the source and the destination are of different type, the - operation fails. - - WalkReturn: - __doc__: | - Enumeration that can be returned by the callback for the `walk()` method to stop the - walking operation early. - CONTINUE: Continue walking normally. - STOP: Stop the walking operation. - SKIP: Skip this folder (no effect if the entry is a file). - - __bool__: - returns: True if this tree is not empty, False otherwise. - - __getitem__: - __doc__: Retrieve the entry at the given index in this tree. - args: - index: Index of the entry to retrieve, must be less than the size. - returns: The entry at the given index. - raises: - IndexError: If the given index is not in range for this tree. - - __iter__: - __doc__: | - Retrieves an iterator for entries directly under this tree. - - This method does not recurse into subtrees, see `walk()` for this. - - # Force the list of arguments to be empty (this will still include self): - args: - - # We are forcing the return type because parsing C++ iterators is a pain: - returns: - __doc__: An iterator object that can be used to iterate over entries in this tree. - type: "Iterator[FileTreeEntry]" - - __len__: - returns: The number of entries directly under this tree. - - addDirectory: - __doc__: | - Create a new directory tree under this tree. - - This method will create missing folders in the given path and will - not fail if the directory already exists but will fail if the given - path contains "." or "..". - This method invalidates iterators to this tree and all the subtrees - present in the given path. - args: - path: Path to the directory to create. - returns: An IFileTree corresponding to the created directory. - raises: - RuntimeError: If the directory could not be created. - - addFile: - __doc__: | - Create a new file directly under this tree. - - This method will fail if the file already exists and `replace_if_exists` is `False`. - This method invalidates iterators to this tree and all the subtrees present in the - given path. - args: - path: Path to the file to create. - replace_if_exists: | - If True and an entry already exists at the given location, it will be replaced by - a new entry. This will replace both files and directories. - returns: A FileTreeEntry corresponding to the created file. - raises: - RuntimeError: If the file could not be created. - - clear: - __doc__: | - Delete (detach) all the entries from this tree. - - This method will go through the entries in this tree and stop at the first - entry that cannot be deleted, this means that the tree can be partially cleared. - returns: True if all entries have been detached, False otherwise. - - copy: - __doc__: | - Move the given entry to the given path under this tree. - - The entry must not be a parent tree of this tree. This method can also be used - to rename entries. - - If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry - at the same location already exists. If the policy is REPLACE, an existing - entry will be replaced. If MERGE, the entry will be merged with the existing - one (if the entry is a file, and a file exists, the file will be replaced). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - args: - entry: Entry to copy. - path: | - The path to copy the entry to. If the path ends with / or \\, the entry will - be copied in the corresponding directory instead of replacing it. If the - given path is empty (`""`), the entry is copied directly under this tree. - policy: Policy to use to resolve conflicts. - returns: The new entry (copy of the specified entry). - raises: - RuntimeError: If the entry could not be copied. - - createOrphanTree: - __doc__: Create a new orphan empty tree. - args: - name: Name of the tree. - returns: A new tree without any parent. - - exists: - __doc__: Check if the given entry exists. - args: - path: Path to the entry, separated by / or \\. - type: The type of the entry to check. - returns: True if the entry was found, False otherwise. - - find: - __doc__: | - Retrieve the given entry. - - If no entry exists at the given path, or if the entry is not of the right - type, `None` is returned. - args: - path: Path to the entry, separated by / or \\. - type: The type of the entry to check. - returns: - __doc__: | - The entry at the given location, or `None` if the entry was not found or - was not of the correct type. - type: Optional[Union["IFileTree", "FileTreeEntry"]] - - insert: - __doc__: | - Insert the given entry in this tree, removing it from its - previouis parent. - - The entry must not be this tree or a parent entry of this tree. - - - If the insert policy if `FAIL_IF_EXISTS`, the call will fail if an entry - with the same name already exists. - - If the policy is `REPLACE`, an existing entry will be replaced by the given entry. - - If the policy is `MERGE`: - - - If there is no entry with the same name, the new entry is inserted. - - If there is an entry with the same name: - - - If both entries are files, the old file is replaced by the given entry. - - If both entries are directories, a merge is performed as if using merge(). - - Otherwize the insertion fails (two entries with different types). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - args: - entry: Entry to insert. - policy: Policy to use to resolve conflicts. - returns: True if the entry was insert, False otherwise. - - merge: - __doc__: | - Merge the given tree with this tree, i.e., insert all entries - of the given tree into this tree. - - The tree must not be this tree or a parent entry of this tree. Files present in both tree - will be replaced by files in the given tree. After a merge, the source tree will be - empty but still attached to its parent. - - If `overwrites` is `True`, a map from overriden files to new files will be returned. - - Note that the merge process makes no distinction between files and directories - when merging: if a directory is present in this tree and a file from source - is in conflict with it, the tree will be removed and the file inserted; if a file - is in this tree and a directory from source is in conflict with it, the file will - be replaced with the directory. - - This method invalidates iterators to this tree, all the subtrees under this tree - present in the given path, and all the subtrees of the given source. - args: - other: Tree to merge. - overwrites: If True, a mapping from overriden files to new files will be returned. - returns: | - If `overwrites` is True, a mapping from overriden files to new files, otherwise - the number of overwritten entries. - raises: - RuntimeError: If the merge failed. - - move: - __doc__: | - Move the given entry to the given path under this tree. - - The entry must not be a parent tree of this tree. This method can also be used - to rename entries. - - If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry - at the same location already exists. If the policy is REPLACE, an existing - entry will be replaced. If MERGE, the entry will be merged with the existing - one (if the entry is a file, and a file exists, the file will be replaced). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - args: - entry: Entry to move. - path: | - The path to move the entry to. If the path ends with / or \\, the entry will - be inserted in the corresponding directory instead of replacing it. If the - given path is empty (`""`), this is equivalent to `insert()`. - policy: Policy to use to resolve conflicts. - returns: True if the entry was moved correctly, False otherwise. - - pathTo: - __doc__: Retrieve the path from this tree to the given entry. - args: - entry: The entry to reach, must be in this tree. - sep: The type of separator to use to create the path. - returns: | - The path from this tree to the given entry, including the name of the entry, or - an empty string if the given entry was not found under this tree. - - remove.1: - __doc__: | - Delete the entry with the given name. - - This method does not recurse into subtrees, so the entry should be - accessible directly from this tree. - args: - name: Name of the entry to delete. - returns: True if the entry was deleted, False otherwise. - - remove.2: - __doc__: Delete the given entry. - args: - entry: Entry to delete. The entry must belongs to this tree (and not to a subtree). - returns: True if the entry was deleted, False otherwise. - - removeAll: - __doc__: | - Delete the entries with the given names from the tree. - - This method does not recurse into subtrees, so only entries accessible - directly from this tree will be removed. This method invalidates iterators. - args: - names: Names of the entries to delete. - returns: The number of deleted entry. - - removeIf: - __doc__: | - Delete entries matching the given predicate from the tree. - - This method does not recurse into subtrees, so only entries accessible - directly from this tree will be removed. This method invalidates iterators. - args: - filter: Predicate that should return true for entries to delete. - returns: The number of deleted entry. - - walk: - __doc__: | - Walk this tree, calling the given function for each entry in it. - - The given callback will be called with two parameters: the path from this tree to the given entry - (with a trailing separator, not including the entry name), and the actual entry. The method returns - a `WalkReturn` object to indicates what to do. - args: - callback: Method to call for each entry in the tree. - sep: Type of separator to use to construct the path. - - IInstallationManager: - __doc__: - - createFile: - __doc__: | - Create a new file on the disk corresponding to the given entry. - - This method can be used by installer that needs to create files that are not in the original - archive. At the end of the installation, if there are entries in the final tree that were used - to create files, the corresponding files will be moved to the mod folder. - - Temporary files corresponding to created files are automatically cleaned up at the end of - the installation. - args: - entry: The entry for which a temporary file should be created. - returns: The path to the created file, or an empty string if the file could not be created. - - extractFile: - __doc__: | - Extract the specified file from the currently opened archive to a temporary - location. - - This method cannot be used to extract directory. - - The call will fail with an exception if no archive is open (plugins deriving from - IPluginInstallerSimple can rely on that, custom installers should not). The temporary - file is automatically cleaned up after the installation. This call can be very slow - if the archive is large and "solid". - args: - entry: Entry corresponding to the file to extract. - silent: If true, the dialog showing extraction progress will not be shown. - returns: | - The absolute path to the temporary file, or an empty string if the file was not extracted. - - extractFiles: - __doc__: | - Extract the specified files from the currently opened archive to a temporary - location. - - This method cannot be used to extract directories. - - The call will fail with an exception if no archive is open (plugins deriving from - IPluginInstallerSimple can rely on that, custom installers should not). The temporary - files are automatically cleaned up after the installation. This call can be very slow - if the archive is large and "solid". - args: - entries: Entries corresponding to the files to extract. - silent: If true, the dialog showing extraction progress will not be shown. - returns: A list containing absolute paths to the temporary files. - - getSupportedExtensions: - returns: The extensions of archives supported by this installation manager. - - installArchive: - __doc__: Install the given archive. - args: - mod_name: Suggested name of the mod. - archive: Path to the archive to install. - mod_id: ID of the mod, if available. - returns: The result of the installation. - - setURL: - __doc__: Set the url associated with the mod being installed. - args: - url: Url to set. - - IModInterface: - - absolutePath: - returns: Absolute path to the mod to be used in file system operations. - - name: - returns: The name of this mod. - - comments: - returns: The comments for this mod, if any. - - notes: - returns: The notes for this mod, if any. - - gameName: - __doc__: | - Retrieve the short name of the game associated with this mod. This may differ - from the current game plugin (e.g. you can install a Skyrim LE game in a SSE - installation). - - returns: The name of the game associated with this mod. - - repository: - returns: The name of the repository from which this mod was installed. - - nexusId: - returns: The Nexus ID of this mod. - - version: - returns: The current version of this mod. - - newestVersion: - returns: | - The newest version of thid mod (as known by MO2). If this matches version(), - then the mod is up-to-date. - - ignoredVersion: - returns: | - The ignored version of this mod (for update), or an invalid version if the user - did not ignore version for this mod. - - installationFile: - returns: The absolute path to the file that was used to install this mod. - - converted: - __doc__: | - Check if the mod was marked as converted by the user. - - When a mod is for a different game, a flag is shown to users to warn them, but - they can mark mods as converted to remove this flag. - - returns: True if this mod was marked as converted by the user. - - validated: - __doc__: | - Check if the mod was marked as validated by the user. - - MO2 uses ModDataChecker to check the content of mods, but sometimes these fail, in - which case mods are incorrectly marked as 'not containing valid games data'. Users can - choose to mark these mods as valid to hide the warning / flag. - - returns: True if th is mod was marked as containing valid game data. - - color: - returns: The color of the 'Notes' column chosen by the user. - - url: - returns: | - The URL of this mod, or an empty QString() if no URL is associated - with this mod. - - primaryCategory: - returns: The ID of the primary category of this mod. - - categories: - returns: The list of categories this mod belongs to. - - trackedState: - returns: The tracked state of this mod. - - endorsedState: - returns: The endorsement state of this mod. - - addCategory: - __doc__: Assign a category to the mod. If the named category does not exist it is created. - args: - name: Name of the new category to assign. - - addNexusCategory: - __doc__: | - Set the category id from a nexus category id. Conversion to MO ID happens internally. - - If a mapping is not possible, the category is set to the default value. - args: - category_id: The Nexus category ID. - - remove: - __doc__: | - Delete the mod from the disc. - - This does not update the global ModInfo structure or indices. - returns: True if the mod was deleted, False otherwise. - - removeCategory: - __doc__: Unassign a category from this mod. - args: - name: Name of the category to remove. - returns: | - True if the category was removed, False otherwise (e.g. if no such category - was assigned). - - setGameName: - __doc__: Set the source game of this mod. - args: - name: The new source game short name of this mod. - - setIsEndorsed: - __doc__: Set endorsement state of the mod. - args: - endorsed: New endorsement state of this mod. - - setName: - __doc__: | - Set the name of this mod. - - This will also update the name of the directory that contains this mod - args: - name: New name for this mod. - returns: | - True if the name was changed, False if an error occured (e.g. if the name is not a valid - directory name). - - setNewestVersion: - __doc__: Set the latest known version of this mod. - args: - version: The latest known version of this mod. - - setNexusID: - __doc__: Set the Nexus ID of this mod. - args: - nexus_id: Thew new Nexus ID of this mod. - - setVersion: - __doc__: Set the version of this mod. - args: - version: The new version of this mod. - - pluginSetting: - __doc__: Retrieve the specified setting in this mod for a plugin. - - args: - plugin_name: | - Name of the plugin for which to retrieve a setting. This should always be `IPlugin.name()` - unless you have a really good reason to access settings of another plugin. - key: Identifier of the setting. - default: The default value to return if the setting does not exist. - - returns: The setting, if found, or the default value. - - pluginSettings: - __doc__: Retrieve the settings in this mod for a plugin. - - args: - plugin_name: | - Name of the plugin for which to retrieve settings. This should always be `IPlugin.name()` - unless you have a really good reason to access settings of another plugin. - - returns: A map from setting key to value. The map is empty if there are not settings for this mod. - - setPluginSetting: - __doc__: Set the specified setting in this mod for a plugin. - - args: - plugin_name: | - Name of the plugin for which to retrieve a setting. This should always be `IPlugin.name()` - unless you have a really good reason to access settings of another plugin. - key: Identifier of the setting. - value: New value for the setting to set. - - returns: True if the setting was set correctly, False otherwise. - - clearPluginSettings: - __doc__: Remove all the settings of the specified plugin this mod. - - args: - plugin_name: | - Name of the plugin for which settings should be removed. This should always be `IPlugin.name()` - unless you have a really good reason to access settings of another plugin. - - returns: The old settings from the given plugin, as returned by `pluginSettings()`. - - IModList: - __doc__: | - Interface to the mod-list. - - All api functions in this interface work need the internal name of a mod to find a - mod. For regular mods (mods the user installed) the display name (as shown to the user) - and internal name are identical. For other mods (non-MO mods) there is currently no way - to translate from display name to internal name because the display name might not me un-ambiguous. - - allMods: - returns: A list containing the internal names of all installed mods. - - displayName: - __doc__: | - Retrieve the display name of a mod from its internal name. - - If you received an internal name from the API (e.g. `IPluginList.origin`) then you should use - that name to identify the mod in all other api calls but use this function to retrieve the name - to show to the user. - args: - name: Internal name of the mod. - returns: The display name of the given mod. - - onModMoved: - __doc__: Install a handler to be called when a mod is moved. - args: - callback: | - The function to call when a mod is moved. The first argument is the internal name of the - mod, the second argument the old priority and the third argument the new priority. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onModStateChanged.1: - __doc__: Install a handler to be called when a mod state changes (enabled/disabled, endorsed, ...). - deprecated: true - args: - callback: | - The function to call when the state of a mod changes. The first argument is the internal - mod name, and the second one the new state of the mod. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onModStateChanged.2: - __doc__: Install a handler to be called when mod states change (enabled/disabled, endorsed, ...). - args: - callback: | - The function to call when the states of mod change. The argument is a map containing the - mods whose states have changed. Keys are internal mod names and values are mod states. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - priority: - __doc__: Retrieve the priority of a mod. - args: - name: Internal name of the mod. - returns: The priority of the given mod. - - setActive.1: - __doc__: | - Enable or disable a list of mods. - - Calling this will cause MO to re-evaluate its virtual file system so this is - a fairly expensive call. - args: - names: Internal names of the mod to enable or disable. - active: True to enable the mods, False to disable them. - returns: True on success, False otherwise. - - setActive.2: - __doc__: | - Enable or disable a mod. - - Calling this will cause MO to re-evaluate its virtual file system so this is - a fairly expensive call. - args: - name: Internal name of the mod to enable or disable. - active: True to enable the mod, False to disable it. - returns: True on success, False otherwise. - - setPriority: - __doc__: | - Change the priority of a mod. - - `priority` is the new priority after the move. Keep in mind that the mod disappears from its - old location and all mods with higher priority than the moved mod decrease in priority by one. - args: - name: Internal name of the mod. - priority: The new priority of the mod. - returns: | - True if the priority was changed, False otherwise (if the name or priority were invalid). - - state: - __doc__: Retrieve the state of a mod. - args: - name: Internal name of the mod. - returns: The state of the given mod. - - IModRepositoryBridge: - - __bases__: - - PyQt5.QtCore.QObject - - signals[]: - descriptionAvailable: - __doc__: | - Emitted when the description for a mod is reported by the repository. - - Valid keys in `result_data` might change as the repository page is updated. For nexus, the following - keys are valid as of this writing: - 'allow_view', 'ip', 'one_week_ratings', 'date', 'pm_notify', 'OLD_mid', 'OLD_u_downloads', 'game_id', 'OLD_perm_use', 'mod_page_uri', - 'allow_topics', 'has_hot_image', 'id', 'two_weeks_ratings', 'description', 'lastupdate', 'perm_convert', 'author', 'OLD_image', - 'translation_of', 'OLD_mname', 'version', 'allow_rating', 'perm_useinstructions', 'featured_count', 'donate', 'type', 'perm_credits', - 'hidden_reason', 'OLD_views', 'perm_upload', 'has_back_image', 'adult', 'allow_images', 'OLD_endorsements', 'OLD_size', 'name', - 'commenting', 'moderate', 'language', 'perm_others', 'lastcomment', 'OLD_readme', 'summary', 'perm_modify', 'OLD_downloads', - 'lock_comments', 'suggested_category', 'allow_tagging', 'published', 'perm_notes', 'category_id', 'thread_id', 'perm_use', 'wizard_steps' - - This interface is going to be changed at some point to replace resultData with a less "dynamic" data structure. - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: Dict[str, MoVariant] - desc: The data included in the response. - - filesAvailable: - __doc__: Emitted when the list of files for a mod is reported by the repository. - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: List[ModRepositoryFileInfo] - desc: List of file information objects. - - fileInfoAvailable: - __doc__: | - Emitted when information about a file is reported by the repository. - - Valid keys in `result_data` might change as the repository page is updated. For nexus, the following - keys are valid as of this writing: - 'count', 'requirements_alert', 'u_count', 'description', 'uri', 'size', 'owner_id', 'primary', 'manager', - 'version', 'date', 'game_id', 'mod_id', 'category_id', 'id', 'name' - - If you intend to download this file you do not have to request this information manually, you can call - IDownloadManager.startDownloadNexusFile() and let the download manager figure things out. - - This interface is going to be changed at some point to replace resultData with a less "dynamic" data structure. - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: Dict[str, MoVariant] - desc: The data included in the response. - - downloadURLsAvailable: - __doc__: | - Emitted when the list of download urls for a file is returned by the repository. - - This interface is going to be changed at some point to replace resultData with a less "dynamic" data structure. - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - file_id: - type: int - desc: ID of the file for which the request was made. - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: Dict[str, MoVariant] - desc: The data included in the response. - - endorsementsAvailable: - __doc__: Emitted when the endorsement data is returned from the API. - args: - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: bool - desc: The new endorsement state. - - endorsementToggled: - __doc__: Emitted when the endorsement state of a mod was changed (only sent as a result of our request). - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: bool - desc: The new endorsement state. - - trackedModsAvailable: - __doc__: Emitted when the tracked mod data is returned from the API. - args: - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: bool - desc: The new tracking state as a list of maps with keys (domain_name, mod_id). - - trackingToggled: - __doc__: Emitted when the tracking state of a mod was changed (only sent as a result of our request). - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - user_data: - type: MoVariant - desc: The data that was included in the request. - result_data: - type: bool - desc: The new tracking state. - - requestFailed: - __doc__: Emitted when a Nexus request failed. - args: - game_name: - type: str - desc: Name of the game. - mod_id: - type: int - desc: ID of the mod for which the request was made. - file_id: - type: int - desc: ID of the file for which the request was made (ignore if the request was for a mod in general). - user_data: - type: MoVariant - desc: The data that was included in the request. - error: - type: PyQt5.QtNetwork.QNetworkReply.NetworkError - desc: The actual error. - message: - type: str - desc: Textual description of the error. - - _object: - returns: The underlying `QObject` for the bridge. - - requestDescription: - __doc__: Request description of a mod. - args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - user_data: User data to be returned with the result. - - requestDownloadURL: - __doc__: Request download URL for mod file.0 - args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - file_id: ID of the file for which a URL should be returned. - user_data: User data to be returned with the result. - - requestFileInfo: - __doc__: - args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - file_id: ID of the file for which information is requested. - user_data: User data to be returned with the result. - - requestFiles: - __doc__: Request the list of files belonging to a mod. - args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - user_data: User data to be returned with the result. - - requestToggleEndorsement: - __doc__: - args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - mod_version: Version of the mod. - endorse: - user_data: User data to be returned with the result. - - IOrganizer: - __doc__: | - Interface to class that provides information about the running session - of Mod Organizer to be used by plugins. - - appVersion: - returns: The running version of Mod Organizer. - - basePath: - returns: The absolute path to the base directory of Mod Organizer. - - createMod: - __doc__: | - Create a new mod with the specified name. - - If a mod with the same name already exists, the user will be queried. If the user chooses - to merge or replace, the call will succeed, otheriwse the call will fail. - args: - name: Name of the mod to create. - returns: | - An interface to the newly created mod that can be used to modify it, or `None` if the mod - could not be created. - - createNexusBridge: - __doc__: Create a new Nexus interface. - returns: The newly created Nexus interface. - - downloadManager: - returns: The interface to the download manager. - - downloadsPath: - returns: The absolute path to the download directory. - - findFileInfos: - __doc__: Find files in the virtual directory matching the specified filter. - args: - path: The path to search in (relative to the 'data' folder). - filter: The function to use to filter files. Should return True for the files to keep. - returns: The list of `QFileInfo` corresponding to the matching files. - - findFiles.1: - __doc__: Find files in the given folder that matches the given filter. - args: - path: The path to search in (relative to the 'data' folder). - filter: The function to use to filter files. Should return True for the files to keep. - returns: The list of matching files. - - findFiles.2: - __doc__: Find files in the given folder that matches one of the given glob patterns. - args: - path: The path to search in (relative to the 'data' folder). - patterns: List of glob patterns to match against. - returns: The list of matching files. - - findFiles.3: - __doc__: Find files in the given folder that matches the given glob pattern. - args: - path: The path to search in (relative to the 'data' folder). - pattern: The glob pattern to use to filter files. - returns: The list of matching files. - - getFileOrigins: - __doc__: | - Retrieve the file origins for the speicified file. - - The origins are listed with their internal name. The internal name of a mod can differ - from the display name for disambiguation. - args: - filename: Path to the file to retrieve origins for (relative to the 'data' folder). - returns: The list of origins that contain the specified file, sorted by their priority. - - getGame: - __doc__: Retrieve the game plugin matching the given name. - args: - name: Name of the game (short name). - returns: The plugin for the given game, or `None` if none was found. - - getMod: - __doc__: Retrieve an interface to a mod using its name. - args: - name: Name of the mod to retrieve. - returns: An interface to the given mod, or `None` if there is no mod with this name - - installMod: - __doc__: Install a mod archive at the specified location. - args: - filename: Absolute filepath to the archive to install. - name_suggestion: Suggested name for this mod. This can still be changed by the user. - returns: An interface to the new installed mod, or `None` if no installation took place (canceled or failure). - - listDirectories: - __doc__: Retrieve the list of (virtual) subdirectories in the given path. - args: - directory: Path to the directory to list (relative to the 'data' folder). - returns: The list of directories in the given directory. - - managedGame: - returns: The plugin corresponding to the current game. - - modDataChanged: - __doc__: Notify the organizer that the given mod has changed. - args: - mod: The mod that has changed. - - modList: - returns: The interface to the mod list. - - modsPath: - returns: The (absolute) path to the mods directory. - - modsSortedByProfilePriority: - returns: The list of mod (names), sorted according to the current profile priorities. - - onAboutToRun: - __doc__: | - Install a new handler to be called when an application is about to run. - - Multiple handlers can be installed. If any of the handler returns `False`, the application will - not run. - args: - callback: | - The function to call when an application is about to run. The parameter is the absolute path - to the application to run. The function can return False to prevent the application from running. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onFinishedRun: - __doc__: Install a new handler to be called when an application has finished running. - args: - callback: | - The function to call when an application has finished running. The first parameter is the absolute - path to the application, and the second parameter is the exit code of the application. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onModInstalled: - __doc__: Install a new handler to be called when a new mod is installed. - args: - callback: | - The function to call when a mod is installed. The parameter of the function is the name of the - installed mod. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onPluginSettingChanged: - __doc__: Install a new handler to be called when a plugin setting is changed. - args: - callback: | - The function to call when a plugin setting is changed. The parameters are: The name of the plugin, the - name of the setting, the old value (or `None` if the setting did not exist before) and the new value - of the setting (or `None` if the setting has been removed). - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onProfileChanged: - __doc__: | - Install a new handler to be called when the current profile is changed. - - The function is called when the profile is changed but some operations related to - the profile might not be finished when this is called (e.g., the virtual file system - might not be up-to-date). - args: - callback: | - The function to call when the current profile is changed. The first parameter is the old profile (can - be `None`, e.g. at startup), and the second parameter is the new profile (cannot be `None`). - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onUserInterfaceInitialized: - __doc__: Install a new handler to be called when the UI has been fully initialized. - args: - callback: | - The function to call when the user-interface has been fully initialized. The parameter is the main - window of the application (`QMainWindow`). - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - overwritePath: - returns: The (absolute) path to the overwrite directory. - - persistent: - __doc__: | - Retrieve the specified persistent value for a plugin. - - A persistent is an arbitrary value that the plugin can set and retrieve that is persistently stored - by the main application. There is no UI for the user to change this value but they can directly access - the storage - args: - plugin_name: | - Name of the plugin for which to retrieve the value. This should always be IPlugin::name() unless you have a - really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - default: Default value to return if the key is not set (yet). - returns: The value corresponding to the given persistent setting, or `def` is the key is not found. - - pluginDataPath: - __doc__: | - Retrieve the path to a directory where plugin data should be stored. - - For python plugins, it is recommended to use a dedicated folder (per plugin) if you need to - store data (resources, or multiple python files). - returns: Path to a directory where plugin data should be stored. - - pluginList: - returns: The plugin list interface. - - pluginSetting: - __doc__: Retrieve settings of plugins. - args: - plugin_name: Name of the plugin to retrieve the setting for. - key: Name of the setting to retrieve the value for. - returns: The value of the setting. - - profile: - returns: The interface to the current profile. - - profileName: - returns: The name of the current profile, or an empty string if no profile has been loaded (yet). - - profilePath: - returns: The absolute path to the active profile or an empty string if no profile has been loaded (yet). - - refreshModList: - __doc__: Refresh the mod list. - args: - save_changes: If True, the relevant profile information is saved first (enabled mods and order of mods). - - removeMod: - __doc__: Remove a mod (from disc and from the UI). - args: - mod: The mod to remove. - returns: True if the mod was removed, False otherwise. - - resolvePath: - __doc__: Resolves a path relative to the virtual data directory to its absolute real path. - args: - filename: Path to resolve. - returns: The absolute real path, or an empty string if the path was not found. - - setPersistent: - __doc__: | - Set the specified persistent value for a plugin. - - This does not update the in-memory value for this setting, see `setPluginSetting()` for this. - args: - plugin_name: | - Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a - really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - value: New value for the setting. - sync: If True, the storage is immediately written to disc. This costs performance but is safer against data loss. - - setPluginSetting: - __doc__: | - Set the specified setting for a plugin. - - This automatically notify handlers register with `onPluginSettingChanged`, so you do not have to do it yourself. - args: - plugin_name: | - Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a - really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - value: New value for the setting. - - startApplication: - __doc__: Starts an application with virtual filesystem active. - args: - executable: | - Name or path of the executable. If this is only a filename, it will only work if it has been configured - in MO as an executable. If it is a relative path it is expected to be relative to the game directory. - args: | - Arguments to pass to the executable. If the list is empty, and `executable` refers to a configured executable, - the configured arguments are used. - cwd: | - The working directory for the executable. If this is empty, the path to the executable is used unless `executable` - referred to a configured MO executable, in which case the configured cwd is used. - profile: Profile to use. If this is empty (the default) the current profile is used. - forcedCustomOverwrite: The mod to set as the custom overwrite, regardless of what the profile has configured. - ignoreCustomOverwrite: Set to true to ignore the profile's configured custom overwrite. - returns: The handle to the started application, or 0 if the application failed to start. - - waitForApplication: - __doc__: | - Wait for the application corresponding to the given handle to finish. - - This will always show the lock overlay, regardless of whether the - user has disabled locking in the setting, so use this with care. - Note that the lock overlay will always allow the user to unlock, in - which case this will return False. - args: - handle: Handle of the application to wait for (as returned by `startApplication()`). - returns: | - A tuple `(result, exitcode)`, where `result` is a boolean indicating if the application - completed successfully, and `exitcode` is the exit code of the application. - - IPlugin: - __doc__: Base class for all plugins. - - __abstract__: true - - author: - returns: The name of the plugin author. - - description: - returns: The description for this plugin. - - init: - __doc__: Initialize this plugin. - args: - organizer: The main organizer interface. - returns: True if the plugin was initialized correctly, False otherwise. - - isActive: - __doc__: | - Check if this plugin is active. - - It is possible to use a plugin setting (specified in `settings()`) here to allow - users to manually enable/disable a plugin. - returns: True if this plugin is active, False otherwise. - - name: - __doc__: | - Retrieve the name of the plugin. - - The name of the plugin is used for internal storage purpose so it should not change, - and it should be static. In particular, you should not use a localized string (`tr()`) - for the plugin name. - - In the future, we will provide a way to localized plugin names using a distinct method, - such as `localizedName()`. - returns: The name of the plugin. - - localizedName: - abstract: false - - __doc__: | - Retrieve the localized name of the plugin. - - Unlike `name()`, this method can (and should!) return a localized name for the plugin. - This method returns name() by default. - - returns: The localized name of the plugin. - - master: - abstract: false - - __doc__: | - Retrieve the master plugin of this plugin. - - It is often easier to implement a functionality as multiple plugins in MO2, but ship the - plugins together, e.g. as a Python module or using `createFunctions()`. In this case, having - a master plugin (one of the plugin, or a separate one) tells MO2 that these plugins are - linked and should also be displayed together in the UI. If MO2 ever implements automatic - updates for plugins, the `master()` plugin will also be used for this purpose. - - returns: | - The master plugin of this plugin, or a null pointer if this plugin does not have a master. - - settings: - returns: A list of settings for this plugin. - - version: - returns: The version of this plugin. - - IPluginDiagnose: - __doc__: | - Plugins that create problem reports to be displayed in the UI. - - This can be used to report problems related to the same plugin (which implements further - interfaces) or as a stand-alone diagnosis tool. - - _invalidate: - __doc__: Invalidate the problems corresponding to this plugin. - abstract: false - - activeProblems: - __doc__: | - Retrieve the list of active problems found by this plugin. - - This method returns a list of problem IDs, that are then used when calling other methods - such as `shortDescription()` or `hasGuidedFix()`. - returns: The list of active problems for this plugin. - - fullDescription: - __doc__: Retrieve the full description of the problem corresponding to the given key. - args: - key: ID of the problem. - returns: The full description of the problem. - raises: - IndexError: If the key is not valid. - - hasGuidedFix: - __doc__: Check if the problem corresponding to the given key has a guided fix. - args: - key: ID of the problem. - returns: True if there is a guided fix for the problem, False otherwise. - raises: - IndexError: If the key is not valid. - - shortDescription: - __doc__: Retrieve the short description of the problem corresponding to the given key. - args: - key: ID of the problem. - returns: The short description of the problem. - raises: - IndexError: If the key is not valid. - - startGuidedFix: - __doc__: | - Starts a guided fix for the problem corresponding to the given key. - - This method should throw `ValueError` if there is no guided fix for the corresponding - problem. - args: - key: ID of the problem. - raises: - IndexError: If the key is not valid. - ValueError: If there is no guided fix for this problem. - - IPluginFileMapper: - __doc__: Plugins that adds virtual file links. - - mappings: - returns: Mapping for the virtual file system (VFS). - - IPluginGame: - __doc__: | - Base classes for game plugins. - - Each game requires a specific game plugin. These plugins were initially designed for - Bethesda games, so a lot of methods and attributes are irrelevant for other games. If - you wish to write a plugin for a much simpler game, please consider the `basic_games` - plugin: https://github.com/ModOrganizer2/modorganizer-basic_games - - CCPlugins: - returns: The current list of active Creation Club plugins. - - DLCPlugins: - returns: The list of esp/esm files that are part of known DLCs. - - binaryName: - returns: The name of the default executable to run (relative to the game folder). - - dataDirectory: - returns: The name of the directory containing data (relative to the game folder). - - documentsDirectory: - returns: The directory of the documents folder where configuration files and such for this game reside. - - executableForcedLoads: - returns: A list of automatically discovered libraries that can be force loaded with executables. - - executables: - returns: A list of automatically discovered executables of the game itself and tools surrounding it. - - feature: - __doc__: Retrieve a specified game feature from this plugin. - abstract: false - args: - feature_type: - __doc__: The class of feature to retrieve. - type: Type[GameFeatureType] - returns: - __doc__: | - The game feature corresponding to the given type, or `None` if the feature is - not implemented. - type: GameFeatureType - - featureList: - __doc__: | - Retrieve the list of game features implemented for this plugin. - - Python plugin should not implement this method but `_featureList()`. - abstract: false - returns: - __doc__: A mapping from feature type to actual game features. - type: Dict[Type[GameFeatureType], GameFeatureType] - - gameDirectory: - returns: The directory containing the game installation. - - gameIcon: - returns: The icon representing the game. - - gameName: - returns: The name of the game (as displayed to the user). - - gameNexusName: - returns: The name of the game identifier for Nexus. - - gameShortName: - returns: The short name of the game. - - gameVariants: - __doc__: | - Retrieve the list of variants for this game. - - If there are multiple variants of a game (and the variants make a difference to the - plugin), like a regular one and a GOTY-edition, the plugin can return a list of them - and the user gets to chose which one he owns. - returns: The list of variants of the game. - - gameVersion: - returns: The version of the game. - - getLauncherName: - returns: | - The name of the launcher executable to run (relative to the game folder), or an - empty string if there is no launcher. - - iniFiles: - returns: | - The list of INI files this game uses. The first file in the list should be the - 'main' INI file. - - initializeProfile: - __doc__: | - Initialize a profile for this game. - - The MO app does not yet support virtualizing only specific aspects but plugins should be written - with this future functionality in mind. - - This function will be used to initially create a profile, potentially to repair it or upgrade/downgrade - it so the implementations have to gracefully handle the case that the directory already contains files. - args: - directory: The directory where the profile is to be initialized. - settings: The parameters for how the profile should be initialized. - - isInstalled: - returns: True if this game has been discovered as installed, False otherwise. - - loadOrderMechanism: - returns: The load order mechanism used by this game. - - looksValid: - __doc__: Check if the given directory looks like a valid game installation. - args: - directory: Directory to check. - returns: True if the directory looks like a valid installation of this game, False otherwise. - - nexusGameID: - __doc__: | - Retrieve the Nexus game ID for this game. - - Example: For Skyrim, the Nexus game ID is 110. - returns: The Nexus game ID for this game. - - nexusModOrganizerID: - __doc__: | - Retrieve the Nexus mod ID of Mod Organizer for this game. - - Example: For Skyrim SE, the mod ID of MO2 is 6194. You can find the mod ID in the URL: - https://www.nexusmods.com/skyrimspecialedition/mods/6194 - returns: The Nexus mod ID of Mod Organizer for this game. - - primaryPlugins: - returns: The list of plugins that are part of the game and not considered optional. - - primarySources: - __doc__: | - Retrieve primary alternative 'short' names for this game. - - This is used to determine if a Nexus (or other) download source should be considered - as a primary source for the game so that it is not flagged as an alternative one. - returns: The list of primary alternative 'short' names for this game, or an empty list. - - savegameExtension: - __doc__: - returns: The file extension of save games for this game. - - savegameSEExtension: - returns: The file extension of Script Extender saves for this game. - - savesDirectory: - returns: The directory where save games are stored. - - setGamePath: - __doc__: | - Set the path to the managed game. - - This is called during instance creation if the game is not auto-detected and the user has - to specify the installation location. This is not called if the game has been auto-detected, - so `isInstalled()` should call this. - args: - path: Path to the game installation. - - setGameVariant: - __doc__: | - Set the game variant. - - If there are multiple variants of game (as returned by `gameVariants()`), this will be - called on start with the user-selected game variant. - args: - variant: The game variant selected by the user. - - sortMechanism: - returns: The sort mechanism for this game. - - steamAPPId: - __doc__: | - Retrieve the Steam app ID for this game. - - If the game is not available on Steam, this should return an empty string. - - If a game is available in multiple versions, those might have different app ids. The plugin - should try to return the right one - returns: The Steam app ID for this game. Should be empty for games not available on steam. - - validShortNames: - __doc__: | - Retrieve the valid 'short' names for this game. - - This is used to determine if a Nexus download is valid for the current game since not all - game variants have their own nexus pages and others can handle downloads from other nexus - game pages and should be allowed to do so (e.g., you can install some Skyrim LE mod even - when using Skyrim SE). - - The short name should be considered the primary handler for a directly supported game - for puroses of auto-launching an instance. - returns: The list of valid short names for this game. - - IPluginInstaller: - __doc__: | - This is the top-level class for installer. Actual installers should inherit either: - - - `IPluginInstallerSimple` if the installer can work directly with the archive. This is what - most installers use. - - `IPluginInstallerCustom` if the installer needs to perform custom operations. This is only - used by the external NCC installer and the OMOD installer. - - isArchiveSupported: - __doc__: Check if the given file tree corresponds to a supported archive for this installer. - args: - tree: The tree representing the content of the archive. - returns: True if this installer can handle the archive, False otherwise. - - isManualInstaller: - __doc__: Check if this installer is a manual installer. - returns: True if this installer is a manual installer, False otherwise. - - onInstallationStart: - __doc__: | - Method calls at the start of the installation process, before any other methods. - This method is only called once per installation process, even for recursive - installations (e.g. with the bundle installer). - - If `reinstallation` is true, then the given mod is the mod being reinstalled (the one - selected by the user). If `reinstallation` is false and `currentMod` is not null, then - it corresponds to a mod MO2 thinks corresponds to the archive (e.g. based on matching Nexus ID - or name). - - The default implementation does nothing. - - args: - archive: Path to the archive that is going to be installed. - reinstallation: True if this is a reinstallation, False otherwise. - current_mod: | - A currently installed mod corresponding to the archive being installed, or None - if there is no such mod. - - onInstallationEnd: - __doc__: | - Method calls at the end of the installation process. This method is only called once - per installation process, even for recursive installations (e.g. with the bundle installer). - - args: - result: The result of the installation. - new_mod: | - If the installation succeeded (result is RESULT_SUCCESS), contains the newly - installed mod, otherwise it contains a null pointer. - - priority: - __doc__: | - Retrieve the priority of this installer. - - If multiple installers are able to handle an archive, the one with the highest priority wins. - returns: The priority of this installer. - - setInstallationManager: - __doc__: | - Set the installation manager for this installer. - - Python plugins usually do not need to re-implement this and can directly access the installation - manager using `_manager()`. - abstract: false - args: - manager: The installation manager. - - setParentWidget: - __doc__: | - Set the parent widget for this installer. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - abstract: false - args: - parent: The parent widget. - - IPluginInstallerCustom: - __doc__: | - Custom installer for mods. Custom installers receive the archive name and have to go - from there. They have to be able to extract the archive themself. - - Example of such installers are the external NCC installer or the OMOD installer. - - _manager: - abstract: false - returns: The installation manager. - - _parentWidget: - abstract: false - returns: The parent widget. - - install: - __doc__: | - Install the given archive. - - The mod needs to be created by calling `IOrganizer.createMod` first. - args: - mod_name: | - Name of the mod to install. As an input parameter this is the suggested name - (e.g. from meta data) The installer may change this parameter to rename the mod). - game_name: Name of the game for which the mod is installed. - archive_name: Name of the archive to install. - version: | - Version of the mod. May be empty if the version is not yet known. The plugin is responsible - for setting the version on the created mod. - nexus_id: | - ID of the mod or -1 if unknown. The plugin is responsible for setting the mod ID for the - created mod. - returns: The result of the installation process. - - isArchiveSupported.1: - __doc__: Check if the given file tree corresponds to a supported archive for this installer. - args: - tree: The tree representing the content of the archive. - returns: True if this installer can handle the archive, False otherwise. - - isArchiveSupported.2: - __doc__: Check if the given file is a supported archive for this installer. - args: - archive_name: Name of the archive. - returns: True if this installer can handle the archive, False otherwise. - - supportedExtensions: - returns: A list of file extensions that this installer can handle. - - IPluginInstallerSimple: - __doc__: | - Simple installer for mods. Simple installers only deal with an in-memory structure - representing the archive and can modify what to install and where by editing this structure. - Actually extracting the archive is handled by the manager. - - _manager: - abstract: false - returns: The installation manager. - - _parentWidget: - abstract: false - returns: The parent widget. - - install: - __doc__: | - Install a mod from an archive filetree. - - The installer can modify the given tree and use the manager to extract or create new - files. - - This method returns different type of objects depending on the actual result of the - installation. The C++ bindings for this method always returns a tuple (result, tree, - version, id). - args: - name: | - Name of the mod to install. As an input parameter this is the suggested name - (e.g. from meta data) The installer may change this parameter to rename the mod). - tree: In-memory representation of the archive content. - version: Version of the mod, or an empty string is unknown. - nexus_id: ID of the mod, or -1 if unknown. - returns: | - In case of failure, the result of the installation, otherwise the modified tree or - a tuple (result, tree, version, id) containing the result of the installation, the - modified tree, the new version and the new ID. The tuple can be returned even if the - installation did not succeed. - - IPluginList: - - __doc__: Primary interface to the list of plugins. - - isMaster: - __doc__: | - Check if a plugin is a master file (basically a library, referenced by other plugins). - - In gamebryo games, a master file will usually have a .esm file extension but technically - an esp can be flagged as master and an esm might not be. - args: - name: Filename of the plugin (without path but with file extension). - returns: True if the given plugin is a master plugin, False otherwise or if the file does not exist. - - loadOrder: - __doc__: Retrieve the load order of a plugin. - args: - name: Filename of the plugin (without path but with file extension). - returns: | - The load order of the plugin (the order in which the game loads it). If all plugins are enabled this - is the same as the priority but disabled plugins will have a load order of -1. This also returns -1 - if the plugin does not exist. - - masters: - __doc__: Retrieve the list of masters required for a plugin. - args: - name: Filename of the plugin (without path but with file extension). - returns: The list of masters for the plugin (filenames with extension, no path). - - onPluginMoved: - __doc__: Install a new handler to be called when a plugin is moved. - args: - callback: | - The function to call when a plugin is moved. The first parameter is the plugin name, the - second the old priority of the plugin and the third one the new priority. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onPluginStateChanged: - __doc__: Install a new handler to be called when a plugin state changes. - args: - callback: | - The function to call when a plugin state changes. The first parameter is the plugin name, the - second the new state of the plugin. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - onRefreshed: - __doc__: Install a new handler to be called when the list of plugins is refreshed. - args: - callback: The function to call when the list of plugins is refreshed. - returns: True if the handler was installed properly (there are currently no reasons for this to fail). - - origin: - __doc__: | - Retrieve the origin of a plugin. This is either the (internal) name of a mod, `"overwrite"` or `"data"`. - - The internal name of a mod can differ from the display name for disambiguation. - args: - name: Filename of the plugin (without path but with file extension). - returns: The name of the origin of the plugin, or an empty string if the plugin does not exist. - - pluginNames: - returns: The list of all plugin names. - - priority: - __doc__: | - Retrieve the priority of a plugin. - - The higher the priority, the more important. - args: - name: Filename of the plugin (without path but with file extension). - returns: The priority of the given plugin, or -1 if the plugin does not exist. - - setPriority: - __doc__: Change the priority of a plugin. - - args: - name: Filename of the plugin (without path but with file extension). - priority: New priority of the plugin. - - returns: | - True on success, False if the priority change was not possible. This is usually because - one of the parameters is invalid. The function returns true even if the plugin was not moved - at the specified priority (e.g. when trying to move a non-master plugin before a master one). - - setLoadOrder: - __doc__: | - Set the load order. - - Plugins not included in the list will be placed at highest priority in the order they - were before. - args: - loadorder: The new load order, specified by the list of plugin names, sorted. - - setState: - __doc__: Set the state of a plugin. - args: - name: Filename of the plugin (without path but with file extension). - state: New state of the plugin (`INACTIVE` or `ACTIVE`). - - state: - __doc__: Retrieve the state of a plugin. - args: - name: Filename of the plugin (without path but with file extension). - returns: The state of the plugin. - - IPluginModPage: - - _parentWidget: - abstract: false - returns: The parent widget. - - displayName: - returns: The name of the page as displayed in the UI. - - handlesDownload: - __doc__: Check if the plugin handles the specified download. - args: - page_url: URL of the page that contains the download link. - download_url: The download URL. - fileinfo: Not usable in python. - returns: True if this plugin wants to handle the specified download, False otherwise. - - icon: - returns: The icon to display with the page. - - pageURL: - returns: The URL to open when the user wants to visit this mod page. - - setParentWidget: - __doc__: | - Set the parent widget for this mod page. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - abstract: false - args: - parent: The parent widget. - - useIntegratedBrowser: - __doc__: | - Indicates if the page should be displayed in the integrated browser. - - Unless the page provides a special means of starting downloads (like the nxm:// url schema - on nexus), it will not be possible to handle downloads unless the integrated browser is used! - returns: True if the page should be opened in the integrated browser, False otherwise. - - IPluginPreview: - __doc__: | - These plugins add support for previewing files in the data pane. Right now all image formats supported - by qt are implemented (including dds) but no audio files and no 3d mesh formats. - - genFilePreview: - __doc__: Generate a preview for the specified file. - args: - filename: Path to the file to preview. - max_size: Maximum size of the generated widget. - returns: The widget showing a preview of the file. - - supportedExtensions: - returns: The list of file extensions that are supported by this preview plugin. - - IPluginTool: - __doc__: | - This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools submenu - and get invoked when the user clicks it. They are expected to have a user interface of some sort. These - are almost like independent applications except they can access all Mod Organizer interfaces like querying - and modifying the current profile, mod list, load order, use MO to install mods and so on. A tool plugin - can (and should!) integrate its UI as a window inside MO and thus doesn't have to initialize a windows - application itself. - - _parentWidget: - abstract: false - returns: The parent widget. - - display: - __doc__: Called when the user starts the tool. - - displayName: - returns: The display name for this tool, as shown in the tool menu. - - icon: - returns: The icon for this tool, or a default-constructed QICon(). - - setParentWidget: - __doc__: | - Set the parent widget for this tool. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - abstract: false - args: - parent: The parent widget. - - tooltip: - returns: The tooltip for this tool. - - IProfile: - __doc__: - absolutePath: - __doc__: - returns: - invalidationActive: - __doc__: - returns: - localSavesEnabled: - __doc__: - returns: - localSettingsEnabled: - __doc__: - returns: - name: - __doc__: - returns: - - ISaveGame: - __doc__: Base class for information about what is in a save game. - - allFiles: - returns: The list of all files related to this save. - - getCreationTime: - __doc__: | - Retrieve the creation time of the save. - - The creation time of a save is not always the same as the creation time of - the file containing the save. - returns: The creation time of the save. - - getFilename: - returns: The name of the (main) save file. - - getSaveGroupIdentifier: - __doc__: | - Retrieve the name of the group this files belong to. - - The name can be used to identify sets of saves to transfer between profiles. For - RPG games, this is usually the name of a character. - returns: The group identifier for this save game. - - hasScriptExtenderFile: - returns: True if this save game has an associated script extender save, False otherwise. - - ISaveGameInfoWidget: - __doc__: Base class for a save game info widget. - # Class not abstract because it conflicts with Qt metaclass: - # __abstract__: true - __init__: - args: - parent: Parent widget. - _widget: - returns: The underlying `QWidget`. - setSave: - abstract: true - __doc__: Set the save file to display in this widget. - args: - save: Path to the save file. - - LocalSavegames: - __doc__: - __abstract__: true - __init__: - __doc__: - mappings: - __doc__: - args: - profile_save_dir: - returns: - prepareProfile: - __doc__: - args: - profile: - returns: - - Mapping: - - __init__: - __doc__: Creates an empty Mapping. - - properties[]: - createTarget: - type: bool - desc: True if file creation (including move or copy) should be redirected to source. - destination: - type: str - desc: The destination of this mapping (absolute path). - isDirectory: - type: bool - desc: True if this mapping corresponds to a directory, False otherwise. - source: - type: str - desc: The source of this mapping (absolute path). - - ModDataChecker: - __doc__: Game feature that is used to check the content of a data tree. - - __abstract__: true - - CheckReturn: - __doc__: - INVALID: The data tree looks invalid and cannot be fixed (automatically). - FIXABLE: The data tree looks valid. - VALID: The data tree looks invalid but can be automatically fixed. - - __init__: - __doc__: - - dataLooksValid: - __doc__: | - Check that the given filetree represent a valid mod layout, or can be easily - fixed. - - This method is mainly used during installation (to find which installer should - be used or to recurse into multi-level archives), or to quickly indicates to a - user if a mod looks valid. - - This method does not have to be exact, it only has to indicate if the given tree - looks like a valid mod or not by quickly checking the structure (heavy operations - should be avoided). - - If the tree can be fixed by the `fix()` method, this method should return `FIXABLE`. - `FIXABLE` should only be returned when it is guaranteed that `fix()` can fix the tree. - args: - filetree: The tree starting at the root of the "data" folder. - returns: Whether the tree is invalid, fixable or valid. - - fix: - __doc__: | - Try to fix the given tree. - - This method is used during installation to try to fix invalid archives and will only be - called if dataLooksValid returned `FIXABLE`. - abstract: false - args: - filetree: The tree to try to fix. Can be modified during the process. - returns: - __doc__: The fixed tree, or a null pointer if the tree could not be fixed. - type: Optional["IFileTree"] - - ModDataContent: - __doc__: | - The ModDataContent feature is used (when available) to indicate to users the content - of mods in the "Content" column. - - The feature exposes a list of possible content types, each associated with an ID, a name - and an icon. The icon is the path to either: - - - A Qt resource or; - - A file on the disk. - - In order to facilitate the implementation, MO2 already provides a set of icons that can - be used. Those icons are all under ``:/MO/gui/content`` (e.g. ``:/MO/gui/content/plugin`` or ``:/MO/gui/content/music`` `). - - The list of available icons is: - - - ``plugin``: |plugin-icon| - - ``skyproc``: |skyproc-icon| - - ``texture``: |texture-icon| - - ``music``: |music-icon| - - ``sound``: |sound-icon| - - ``interface``: |interface-icon| - - ``skse``: |skse-icon| - - ``script``: |script-icon| - - ``mesh``: |mesh-icon| - - ``string``: |string-icon| - - ``bsa``: |bsa-icon| - - ``menu``: |menu-icon| - - ``inifile``: |inifile-icon| - - ``modgroup``: |modgroup-icon| - - .. |plugin-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/jigsaw-piece.png - .. |skyproc-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/hand-of-god.png - .. |texture-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/empty-chessboard.png - .. |music-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/double-quaver.png - .. |sound-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/lyre.png - .. |interface-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/usable.png - .. |skse-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/checkbox-tree.png - .. |script-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/tinker.png - .. |mesh-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/breastplate.png - .. |string-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/conversation.png - .. |bsa-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/locked-chest.png - .. |menu-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/config.png - .. |inifile-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/feather-and-scroll.png - .. |modgroup-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/xedit.png - - __abstract__: true - - Content: - __doc__: - - __init__: - __doc__: - - args: - id: ID of this content. - name: Name of this content. - icon: | - Path to the icon for this content. Can be either a path - to an image on the disk, or to a resource. Can be an empty string if filterOnly - is true. - filter_only: | - Indicates if the content should only be show in the filter - criteria and not in the actual Content column. - - isOnlyForFilter: - __doc__: - returns: True if this content is only meant to be used as a filter criteria. - - properties[]: - id: - type: int - desc: The ID of this content. - name: - type: str - desc: The name of this content. - icon: - type: str - desc: The path to the icon of this content (can be a Qt resource path). - - __init__: - __doc__: - - getAllContents: - __doc__: - returns: The list of all possible contents for the corresponding game. - - getContentsFor: - __doc__: Retrieve the list of contents in the given tree. - args: - filetree: The tree corresponding to the mod to retrieve contents for. - returns: The IDs of the content in the given tree. - - ModRepositoryFileInfo: - __doc__: - properties[]: - categoryID: - type: int - desc: - description: - type: str - desc: - fileCategory: - type: int - desc: - fileID: - type: int - desc: - fileName: - type: str - desc: - fileSize: - type: int - desc: - fileTime: - type: PyQt5.QtCore.QDateTime - desc: - gameName: - type: str - desc: - modID: - type: int - desc: - modName: - type: str - desc: - name: - type: str - desc: - newestVersion: - type: VersionInfo - desc: - repository: - type: str - desc: - uri: - type: str - desc: - userData: - type: MoVariant - desc: - version: - type: VersionInfo - desc: - - __init__.1: - __doc__: - args: - other: - __init__.2: - __doc__: - args: - game_name: - mod_id: - file_id: - __str__: - __doc__: - returns: - createFromJson: - __doc__: - args: - data: - returns: - - PluginSetting: - __doc__: | - Class to hold the user-configurable parameters a plugin accepts. The purpose of this class is - only to inform the application what settings to offer to the user, it does not hold the actual value. - properties[]: - default_value: - type: MoVariant - desc: Default value of the setting. - description: - type: str - desc: Description of the setting. - key: - type: str - desc: Name of the setting. - - __init__: - __doc__: - args: - key: Name of the setting. - description: Description of the setting. - default_value: Default value of the setting. - - SaveGameInfo: - __doc__: Feature to get hold of stuff to do with save games. - __abstract__: true - __init__: - __doc__: - - getMissingAssets: - __doc__: Retrieve missing assets from the save. - args: - filepath: Path to the save file. - returns: | - A collection of missing assets and the modules that can supply those assets. - - getSaveGameInfo: - __doc__: Retrieve the information about the supplied save game. - args: - filepath: Path to the save file. - returns: A SaveGame corresponding to the given save file. - - getSaveGameWidget: - __doc__: | - Retrieve a widget to display over the save game list. - - This method is allowed to return `None` in case no widget has been implemented. - args: - parent: The parent widget. - returns: - __doc__: A SaveGameInfoWidget to display information about save game. - type: Optional["ISaveGameInfoWidget"] - - hasScriptExtenderSave: - __doc__: Check whether or not the save has a paired script extender save. - args: - filepath: Path to the save file. - returns: | - True if the given save file has a paired script extender save, False otherwise. - - ScriptExtender: - __doc__: - __abstract__: true - - BinaryName: - __doc__: - returns: The name of the script extender binary. - - PluginPath: - __doc__: - returns: The script extender plugin path, relative to the data folder. - - getArch: - __doc__: - returns: The CPU platform of the extender. - - getExtenderVersion: - __doc__: - returns: The version of the script extender. - - isInstalled: - __doc__: - returns: True if the script extender is installed, False otherwise. - - loaderName: - __doc__: - returns: The loader to use to ensure the game runs with the script extender. - - loaderPath: - __doc__: - returns: The fullpath to the script extender loader. - - # TODO: Remove this? Deprecated? - saveGameAttachmentExtensions: - __doc__: - returns: Additional savegame attachments. - - UnmanagedMods: - __doc__: - __abstract__: true - - displayName: - __doc__: Retrieve the display name of a given mod. - args: - mod_name: Internal name of the mod. - returns: The display name of the mod. - - mods: - __doc__: Retrieve the list of unmanaged mods for the corresponding game. - args: - official_only: Retrieve only unmanaged official mods. - returns: The list of unmanaged mods (internal names). - - referenceFile: - __doc__: | - Retrieve the reference file for the requested mod. - - Example: For Bethesda games, the reference file may be the main - plugin (esp or esm) for the game or a DLCs. - args: - mod_name: Internal name of the mod. - returns: The reference file (absolute path) for the requested mod. - - secondaryFiles: - __doc__: | - Retrieve the secondary files for the requested mod. - - Example: For Bethesda games, the secondary files may be the archives - corresponding to the reference file. - args: - mod_name: Internal name of the mod. - returns: The secondary files (absolute paths) for the request mod. - - VersionInfo: - __doc__: Represents the version of a mod or plugin. - - __init__.1: Construct an invalid VersionInfo. - - __init__.2: - __doc__: Construct a VersionInfo by parsing the given string according to the given scheme. - - args: - value: String to parse. - scheme: Scheme to use to parse the string. - - __init__.3: - __doc__: Construct a VersionInfo using the given elements. - - args: - major: Major version. - minor: Minor version. - subminor: Subminor version. - subsubminor: Subsubminor version. - release_type: Type of release. - - __init__.4: - __doc__: Construct a VersionInfo using the given elements. - - args: - major: Major version. - minor: Minor version. - subminor: Subminor version. - release_type: Type of release. - - __str__: - returns: > - See `canonicalString()`. - - canonicalString: - returns: > - A canonical string representing this version, that can be stored and then parsed using - the parse() method. - - clear: Resets this VersionInfo to an invalid version. - - displayString: - args: - forced_segments: | - The number of version segments to display even if the version is 0. 1 is major, 2 is major - and minor, etc. The only implemented ranges are (-inf,2] for major/minor, [3] for major/minor/subminor, - and [4,inf) for major/minor/subminor/subsubminor. This only versions with a regular scheme. - returns: > - A string for display to the user. The returned string may not contain enough information - to reconstruct this version info. - - isValid: - returns: True if this VersionInfo is valid, False otherwise. - - parse: - __doc__: Update this VersionInfo by parsing the given string using the given scheme. - - args: - value: String to parse. - scheme: Scheme to use to parse the string. - manual_input: True if the given string should be treated as user input. - - scheme: - returns: The version scheme in effect for this VersionInfo. diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index d0c3cbf..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 9534b01..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 9017ef6..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -sphinx-rtd-theme -sphinx-autodoc-typehints -sphinx-automodapi -PyQt5 \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index a0f0604..0000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,70 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import os -import sys - -sys.path.insert(0, os.path.abspath("../../stubs/2.3rc1/")) - - -# -- Project information ----------------------------------------------------- - -project = "MO2 Python Plugin API" -copyright = "2020, Holt59" -author = "Holt59" - -# The full version, including alpha/beta/rc tags -release = "2.3rc1" - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx_autodoc_typehints", - "sphinx.ext.napoleon", - # "sphinx.ext.autosummary", - "sphinx_automodapi.automodapi", -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = "sphinx_rtd_theme" - -html_theme_options = { - # Toc options - "collapse_navigation": False, - "titles_only": False, -} -html_sidebars = { - "**": ["globaltoc.html", "relations.html", "sourcelink.html", "searchbox.html"] -} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] diff --git a/docs/source/faq.rst b/docs/source/faq.rst deleted file mode 100644 index de44220..0000000 --- a/docs/source/faq.rst +++ /dev/null @@ -1,53 +0,0 @@ -FAQ -=== - -.. toctree:: - :maxdepth: 4 - -1. Why is MO2 throwing an exception when I try to create a type inheriting one of MO2 class? -............................................................................................ - -This often happens if you forget to call ``super().__init__()`` with the right arguments. -Even if the list of arguments is empty (as in the example), it must be called due to a "bug" -in ``boost::python``: - -.. code-block:: python - - class MySaveGame(mobase.ISaveGame): - def __init__(self): - super().__init__() # Mandatory! - -2. How can I be sure to implement all the required methods when creating a plugin? -.................................................................................. - -It is kind of annoying to create a MO2 python plugin that kind of works and have it crash -at some point simply because there plugin is missing a function implementation. -You can have ``mypy`` warn you for such issue by typing the ``createPlugin`` or ``createPlugins`` -functions: - -.. code-block:: python - - import typing - - # A plugin that is missing something (e.g. display()). - class MyPlugin(mobase.IPluginTool): ... - - # If you type-hint `createPlugin` by adding `-> mobase.IPlugin`, - # `mypy` will warn you that `MyPlugin` is an incomplete class. - def createPlugin() -> mobase.IPlugin: - return MyPlugin() - - # You can also type-hint `createPlugins`: - def createPlugins() -> typing.List[mobase.IPlugin]: - return [MyPlugin()] - - -3. Why are my ``isinstance(x, QObject)`` and ``isinstance(y, QWidget)`` not working? -.................................................................................... - -Some classes from ``mobase`` are said to inherit ``QObject`` and ``QWidget`` in the -stubs, such as :class:`mobase.IDownloadManager`. -This is not the case in practice due to limitation in Python and ``boost::python``. -The bases are in the stubs to allow for auto-completion and typing, which is then -simulated in the real ``mobase`` by overriding ``__getattr__`` and delegating to -the underlying ``QObject`` or ``QWidget``. \ No newline at end of file diff --git a/docs/source/images/check-setup-1.png b/docs/source/images/check-setup-1.png deleted file mode 100644 index 88053cd..0000000 Binary files a/docs/source/images/check-setup-1.png and /dev/null differ diff --git a/docs/source/images/check-setup-2.png b/docs/source/images/check-setup-2.png deleted file mode 100644 index 31def51..0000000 Binary files a/docs/source/images/check-setup-2.png and /dev/null differ diff --git a/docs/source/images/check-setup-3.png b/docs/source/images/check-setup-3.png deleted file mode 100644 index d56f9c8..0000000 Binary files a/docs/source/images/check-setup-3.png and /dev/null differ diff --git a/docs/source/images/error-window.png b/docs/source/images/error-window.png deleted file mode 100644 index 445e5da..0000000 Binary files a/docs/source/images/error-window.png and /dev/null differ diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index ef93b56..0000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. MO2 Python Plugin API documentation master file, created by - sphinx-quickstart on Wed Jul 15 19:36:59 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to MO2 Python Plugin API's documentation! -================================================= - -Plugins are a way to extend Mod Organizers functionality. You can write plugins in either C++ or Python, -theoretically with either being as powerful as the other. -This documentation is dedicated to writting MO2 **Python** plugins. - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - setup-tools - plugin-types - writing-plugins - faq - mobase - - - -.. Indices and tables -.. ================== - -.. * :ref:`genindex` -.. * :ref:`modindex` -.. * :ref:`search` diff --git a/docs/source/mobase.rst b/docs/source/mobase.rst deleted file mode 100644 index 26a456f..0000000 --- a/docs/source/mobase.rst +++ /dev/null @@ -1,11 +0,0 @@ -``mobase`` API -============== - -.. currentmodule:: mobase - -.. automodapi:: mobase - :no-inheritance-diagram: - :no-heading: - -.. toctree:: - :maxdepth: 4 diff --git a/docs/source/modules.rst b/docs/source/modules.rst deleted file mode 100644 index 2b6dad5..0000000 --- a/docs/source/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -mobase -====== - -.. toctree:: - :maxdepth: 4 - - mobase diff --git a/docs/source/plugin-types.rst b/docs/source/plugin-types.rst deleted file mode 100644 index c41cbc0..0000000 --- a/docs/source/plugin-types.rst +++ /dev/null @@ -1,150 +0,0 @@ -.. _type-of-plugins: - -Type of Plugins -=============== - -Plugins are passive, that is: they react to events emitted by the core application or extend -an existing functionality (like adding support for additional types of installers). Plugins -should integrate with Mod Organizers concepts. While you could write an INI editor that works with -the global INI files instead of the profile specific ones, what would be the point? - -Depending on where/how the plugin integrates with MO you need to write a different type of plugin, -in practice this means you need to implement a different interface (inherit from a different base -plugin class from ``mobase``). As mentioned above, plugins are passive: the plugin type decides how/when -MO makes requests to/invokes your plugin. -All plugins however gain access to MOs own plugin interface so all plugins get to make the same requests -to MO. - -Installers ----------- - -| **Interface:** :class:`IPluginInstaller`, :class:`IPluginInstallerSimple`, - :class:`IPluginInstallerCustom` -| **Examples:** ``installer_bain``, ``installer_bundle``, ``installer_fomod``, ``installer_ncc``, ``installer_quick``, ``installer_manual``. - -An installer is invoked when the user tries to install a mod, either by double clicking in the download -view or through the "Install Mod.." button or "Reinstall mod" item from the mod lists context menu. -There are actually two ways to write an installer, *simple* or *complex*: - -- With *simple* installers, MO does the unpacking of the file but this works only with standard archive formats. - The plugin can then select the files and folders that requires extraction, and where to extract them. -- *Complex* installers are more flexible but require a bit more work. - -Previewers ----------- - -| **Interfaces:** :class:`IPluginPreview` -| **Examples:** ``preview_base`` - -These plugins add support for previewing files in the data pane. -Right now all image formats supported by Qt are implemented (including `.dds`) but no audio files and -no 3d mesh formats. - -Mod Page --------- - -*WIP* - -| **Interfaces:** :class:`IPluginModPage` -| **Examples:** ``page_tesalliance`` - -Mod Page plugins implement interfaces to modding communities where mods can be downloaded, checked -for updates and so on. -This interface is not finished and some of the bits that are do not actually get used. The goal is -that the whole Nexus integration can be implemented through this interface and can then be removed -from the core application. This is a task for the distant future, unless someone wants to volunteer. - -Game ----- - -| **Interfaces:** :class:`IPluginGame` -| **Examples:** ``game_oblivion``, ``game_fallout3``, ``game_falloutnv``, ``game_skyrim``, ... - -These plugins (shall eventually) implement all the game specific features and further game plugins are -able to add support for further games. -The plugin is also responsible to help MO determine if (and where) the game is installed in the first place. -Since supporting a game properly requires extensions in many places of the UI. -To allow this without creating one huge plugin interface that involves every aspect of MO, game plugins -expose a *feature list*. -The list of possible features can be found in the "game_features" project and each feature can itself be -considered a plugin interface. - -As an example for a game feature take BSA invalidation: If the game requires BSA invalidation it will implement -this feature. -Wherever the core can support BSA invalidation it will query whether the current game has this feature and if so -query the implementation on specifics (like "How should the invalidation BSA be called" and "what's the right bsa version"). -Of course, the goal is for feature interfaces to be as generic as possible without limiting usefulness. - -**Note:** The :class:`IPluginGame` interface is complex, and mostly designed for Gamebryo games. If you plan -on writting a game plugin for another type of games, you might be interested by a simpler interface and might -want to check out the `Basic Games `_ meta-plugin. - - -Tool ----- - -| **Interfaces:** :class:`IPluginTool` -| **Examples:** ``tool_configurator``, ``tool_inieditor``, ``fnistool`` - -This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools submenu and get -invoked when the user clicks it. They are expected to have a user interface of some sort. -These are almost like independent applications except they can access all Mod Organizer interfaces like querying -and modifying the current profile, mod list, load order, use MO to install mods and so on. -A tool plugin can (and should!) integrate its UI as a window inside MO and thus doesn't have to initialize a -windows application itself. - -Proxies -------- - -| **Interfaces:** :class:`IPluginProxy` -| **Examples:** ``plugin_python`` - -Proxy Plugins expose the plugin api to foreign languages. This is what allows you to write plugins using python -in the first place. -The python proxy is easily the most complicated plugin and requires constant updating so if you're considering -writing a Haskell plugin because that is your programming language of choice, I am fairly certain learning python -is easier than writing the haskell proxy. Just saying. -And no, you can not write a proxy for a third language in Python, do not be silly. - -*Free Plugins* --------------- - -| **Interfaces:** :class:`IPlugin` -| **Examples:** ``check_fnis``, ``bsa_extractor``, ``diagnose_basic``, ``tool_inibakery`` - -"Free" plugins implement none of the interfaces and thus initially do not integrate with MO at all. -They are initialized by MO and get access to the MO interface. -This makes sense if you only want to implement one of the extension interfaces (see below) or register handlers -for events. - -Extension Interfaces --------------------- - -In Python, these interfaces are similar to other plugin types, but in C++, those do not inherit ``IPlugin`` so -that plugins can implement one or more of these interfaces, in addition to a normal plugin type. - -Diagnose -........ - -| **Interfaces:** :class:`IPluginDiagnose` -| **Examples:** ``diagnose_basic``, ``installer_ncc``, ``plugin_python``, ``script_extender_plugin_checker`` - -This interface lets the plugin report issues that are then listed in the "Problems" icon in the main window. -If possible the plugin can also provide an automatic or guided fix to the problem. -The ``diagnose_basic`` plugin does nothing but analyze the MO installation and report problems it discovers (like -*"There are files in your overwrite directory."*) but usually a plugin will want to report issues relevant for its -own operation. -For instance, ``installer_ncc`` requires a specific version of .NET and will report a problem if it is not installed. -This should always be the prefered way to communicate problems the user has to fix but should never be used for problems -he cannot fix (i.e. *"This plugin does not work with this game."*). -An empty problem list should always be achievable. - -File Mappings -............. - -| **Interfaces:** :class:`IPluginFileMapper` -| **Examples:** ``tool_inibakery``, ``game_gamebryo`` - -This interface allows plugins to add virtual file (or directory) links to the virtual file system in addition to the -mod files. -Profile-local save games, ini-files and load-orders are all implemented this way in MO2. \ No newline at end of file diff --git a/docs/source/setup-tools.rst b/docs/source/setup-tools.rst deleted file mode 100644 index 15c5aab..0000000 --- a/docs/source/setup-tools.rst +++ /dev/null @@ -1,135 +0,0 @@ -Setting up the environment -========================== - -This page will get you started for creating a MO2 python plugin. If you have troubles getting -everything setup, feel free to come by our discord server at `https://discord.gg/cYwdcxj `_. - -Required tools --------------- - -It is possible to write a MO2 python plugin using any text editor, but this guide will focus on -`Visual Studio Code `_. -This guide assumes that: - -- You have `Visual Studio Code `_ installed with the - `Python extension `_. -- You have Python installed: https://www.python.org/downloads/. - - - It is recommended but not mandatory to use the Python version that is used by MO2. - You can check the ``pythonXX.dll`` in the MO2 installation folder to find the Python version used by MO2 (``python38.dll`` means Python 3.8). -- You obviously need a valid MO2 installation: https://github.com/modorganizer2/modorganizer/releases - - - This guide is written for MO2 ā‰„ 2.3.0. - -**Note:** In the following, I will refer to the MO2 installation directory as ``$MO2DIR``. So if you -installed MO2 at ``C:\MO2`` and you are asked to copy a file to ``$MO2DIR/plugins``, it refers to ``C:\MO2\plugins``. - -Preparation ------------ - -**Note:** This part is optional but highly recommended if you want a proper environment to work with. -Everything here is written to be as simple as possible but you can of course adapt it to your preferences: use a python virtual -environment, use workspace settings instead of global ones, etc. - -1. Get the ``mobase`` stubs -........................... - -``mobase`` is the MO2 Python module. The module is written in C++ and thus cannot be read directly by tools such -as ``flake8`` or ``mypy``. -Instead, we provide `stubs `_ -which can be used for auto-completion or type-checking. - -The stubs for ``mobase`` are available at https://github.com/ModOrganizer2/pystubs-generation/tree/master/stubs. -You want to download the ``mobase.pyi`` file in the folder corresponding to your MO2 version and put it under ``$MO2DIR/plugins/data``. - -**Note:** It is possible to put the stubs in a different location, but we are going to use ``$MO2DIR/plugins/data`` for PyQt5, -so we might as well use it for the stubs. - -2. Configure Visual Studio Code for ``mobase`` -.............................................. - -We are going to configure Visual Studio Code to have auto-completion and linting (error and type checking) -for the MO2 Python module. -Open ``settings.json`` (Ctrl+Shift+P, then "Open Settings (JSON)"), and add the following entries: - -.. code-block:: json-object - - "python.linting.enabled": true, - "python.linting.mypyEnabled": true, - "python.linting.flake8Enabled": true, - "python.autoComplete.extraPaths": [ - "$MO2DIR\\plugins\\data", - ] - -3. Configure ``mypy`` to find the ``mobase`` stubs -.................................................. - -There are multiply way to configure ``mypy``: - -1. You can create a ``mypy.ini`` file somewhere containing: - -.. code-block:: ini - - [mypy] - mypy_path = $MO2DIR\plugins\data - -And then add the following to ``settings.json`` (with the correct path): - -.. code-block:: json-object - - "python.linting.mypyArgs": [ - "--config-file=path-to-mypy.ini", - ] - -2. You can set the ``MYPYPATH`` environment variable to ``$MO2DIR\plugins\data`` (this requires -restarting VS code). - -Testing the setup ------------------ - -Create a new Python file in Visual Studio Code, and paste the following content (if you create -the file in ``$MO2DIR\plugins``, do not forget to delete it after since it is not a valid -plugin): - -.. code-block:: python - - import mobase - - - class MyPlugin(mobase.IPluginTool): - def __init__(self): - super().__init__() - - def init(self, organizer: mobase.IOrganizer) -> bool: - organizer.dow # (1) - return True - - def name(self) -> int: - return 0 - - - def createPlugin() -> mobase.IPlugin: - return MyPlugin() - - -If your setup is valid, here is what you should have. - -- You should see the following (with the errors underlined): - -.. image:: images/check-setup-1.png - -- If you press ``Ctrl+Space`` after ``.down`` (1), you should see the following - meaning that auto-complete is working: - -.. image:: images/check-setup-2.png - -- In the error window (click |error-window| on the status bar), you should see - the 3 following errors: - -.. image:: images/check-setup-3.png - -If everything is as above, you can delete the test file and move on to writting -your own plugin! - - -.. |error-window| image:: images/error-window.png \ No newline at end of file diff --git a/docs/source/writing-plugins.rst b/docs/source/writing-plugins.rst deleted file mode 100644 index 153ecfb..0000000 --- a/docs/source/writing-plugins.rst +++ /dev/null @@ -1,201 +0,0 @@ -Writing Plugins -=============== - -Getting started ---------------- - -Now that you know which type of plugin you need, you can start writing your own plugin. -There is two way to write a Python plugin: - -- :ref:`single-file-plugin`: You use a single ``.py`` file that you put directly in the ``plugins`` - folder of the MO2 installation. -- :ref:`module-plugin`: You create a Python package (folder) with a ``__init__.py`` file that you - put in the ``plugins`` folder of the MO2 installation. - -Most examples of plugins will be module plugins. - -.. _single-file-plugin: - -Single file plugins -................... - -Prior to version 2.3, this was the only way of creating a Python plugin. You simply need -to create a ``myplugin.py`` file in the ``plugins`` folder of Mod Organizer 2 with a content -similar to: - -.. code-block:: python - - import mobase - - class MyPlugin(...): - ... - - def createPlugin() -> mobase.IPlugin: - return MyPlugin() - -We will see later on how to create the actual ``MyPlugin`` class. -The ``createPlugin`` function is the function that is called by Mod Organizer 2 to instantiate -the plugin. - -You can also provide multiple plugins by using ``createPlugins`` instead of ``createPlugin``: - -.. code-block:: python - - from typing import List - - import mobase - - class MyPlugin1(...): - ... - - class MyPlugin2(...): - ... - - - def createPlugins() -> List[mobase.IPlugin]: - return [MyPlugin1(), MyPlugin2()] - -**Note:** If you provide neither ``createPlugin()`` nor ``createPlugins``, MO2 will display -an error message in the logs. - -**Note:** If you add a return type-hint to ``createPlugin()`` or ``createPlugins`` (``->``), ``mypy`` -will type-check the function and warn you if one of your plugins is invalid, e.g. if you -forgot to implement a required method. - -If you need to provide other files with your ``.py`` (assets or other Python files), you can -put them in the ``plugins/data``, but this is deprecated since MO2 2.3, and you should instead -create a Python module plugin. - -.. _module-plugin: - -Module Plugins -.............. - -Module plugins were introduced in MO2 2.3 and are shipped as whole folder containg a python module. -The minimum content of the folder is a ``__init__.py`` file with ``createPlugin`` or ``createPlugins`` -function. - -A minimal module plugin could be as follows: - -.. code-block:: bash - - plugins/ # MO2 plugins folder - myplugin/ - __init__.py - plugin.py - -In ``plugin.py``, you could define your plugin: - -.. code-block:: python - - # plugin.py - - import mobase - - class MyPlugin(...): - ... - -And in ``__init__.py``, you should write ``createPlugin``: - -.. code-block:: python - - # __init__.py - - import mobase # For type-checking createPlugin(). - - from .plugin import MyPlugin # Always use relative import: - - def createPlugin() -> mobase.IPlugin: - return MyPlugin() - -Similar to single-file plugins, you can expose ``createPlugins`` instead of ``createPlugin`` -to instantiate multiple plugins. - -**Note:** The name of the folder does not have to be a valid python package, and you should -always use relative imports within the module (``import .xxx``) instead of absolute ones. - -Writing the plugin ------------------- - -``IPlugin`` interface -..................... - -In the code snippets above, the ``MyPlugin`` class was not implemented. -Depending on the :ref:`type of plugins` that you want to create, you will -need to extend a different class. - -.. code-block:: python - - class MyTool(mobase.IPluginTool): # Create a Tool plugin - ... - - class MyPreview(mobase.IPluginPreview): # Create a preview plugin - ... - -Each plugin class has its own abstract methods that you need to implement but all the classes -also extend ``IPlugin``, so you need to implement the methods from :class:`IPlugin`: - -.. code-block:: python - - from typing import List - - import mobase - - class MyPlugin(...): # The base class depends on the actual type of plugin - - _organizer: mobase.IOrganizer - - def __init__(self): - super().__init__() # You need to call this manually. - - def init(self, organizer: mobase.IOrganizer): - self._organizer = organizer - return True - - def name(self) -> str: - return "" - - def author(self) -> str: - return "Tannin" - - def description(self) -> str: - return self._tr("Gives a friendly greeting") - - def version(self) -> mobase.VersionInfo: - return mobase.VersionInfo(1, 0, 0, mobase.ReleaseType.FINAL) - - def isActive(self) -> bool: - return self._organizer.pluginSetting(self.name(), "enabled") - - def settings(self) -> List[mobase.PluginSetting]: - return [ - mobase.PluginSetting("enabled", "enable this plugin", True) - ] - -Most of these are pretty simple to understand: - -- ``name``: Returns the name of the plugin. The name of the plugin is used to - fetch settings, and in many places, so this should not change between versions. -- ``author``: Returns the name of the plugin author (you!). -- ``description``: Returns the description of the plugin. -- ``version``: Returns the version of the plugin. See :class:`VersionInfo` for - more details. -- ``isActive``: Returns ``True`` if the plugin is active, ``False`` otherwise. This - usually returns ``True``, unless you want to check for something to dynamically - enable the plugin. You can also use a plugin setting to allow users to disable - your plugins. -- ``settings``: Returns the list of settings (that user can modify) for this plugin. - Settings can be ``int```, ``bool``, ``str`` or list of ``str``. Here we indicate - that we have a "enabled" setting that user could use to disable the plugin (and - we use it in ``isActive``). - - -The ``__init__`` method is the normal Python constructor for our plugin, called when doing -``MyPlugin()``. -You should always call ``super().__init__()`` explicitly when extending MO2 classes (due to -a "bug" in ``boost.python``). - -The ``init`` method is called by MO2 to initialize the plugin. The given argument, ``organizer``, -is an instance of :class:`IOrganizer` which is the class used to interface with MO2. -Here, we use it in the ``isActive()`` method to retrieve the "enabled" setting for our plugin. -See :class:`IOrganizer` for more details. \ No newline at end of file diff --git a/generator/__init__.py b/generator/__init__.py deleted file mode 100644 index 4e3743d..0000000 --- a/generator/__init__.py +++ /dev/null @@ -1,9 +0,0 @@ -# -*- encoding: utf-8 -*- - -import logging -import sys - - -logging.basicConfig(stream=sys.stderr, format="%(levelname)s: %(message)s") -logger = logging.getLogger(__name__) -logger.setLevel(logging.WARNING) diff --git a/generator/loader.py b/generator/loader.py deleted file mode 100644 index 51364e5..0000000 --- a/generator/loader.py +++ /dev/null @@ -1,75 +0,0 @@ -# -*- encoding: utf-8 -*- - -import importlib.machinery -import os -import sys - -from pathlib import Path - - -def load_mobase(path: Path, moprivate: bool = False): - """ Load the mobase from the given MO2 installation path and - returns it. - - Args: - path: Path to the MO2 installation (folder containg the ModOrganizer.exe). - moprivate: If True, the moprivate module will also be loaded and returned - alongisde mobase. - - Returns: The mobase module. """ - - # We need absolute path for loading DLL and modules: - path = path.resolve() - - # Adding to PATH environment variable for python < 3.8 and - # via os.add_dll_directory (python >= 3.8). - # See: https://stackoverflow.com/a/58632354/2666289 - if sys.version_info < (3, 8): - os.environ["PATH"] = os.pathsep.join( - [str(path), str(path.joinpath("dlls")), os.environ.get("PATH", "")] - ) - else: - os.add_dll_directory(str(path)) - os.add_dll_directory(str(path.joinpath("dlls"))) - - # We need to add plugins/data to sys.path, mainly for PyQt5 - sys.path.insert(1, path.joinpath("plugins", "data").as_posix()) - - mobase = importlib.machinery.ExtensionFileLoader( - "mobase", path.joinpath("plugins", "data", "pythonrunner.dll").as_posix() - ).load_module() - - if not moprivate: - return mobase - - moprivate = importlib.machinery.ExtensionFileLoader( - "moprivate", path.joinpath("plugins", "data", "pythonrunner.dll").as_posix() - ).load_module() - - return mobase, moprivate - - -if __name__ == "__main__": - - import argparse - - parser = argparse.ArgumentParser( - "Load mobase python module from MO2 installation directory" - ) - parser.add_argument( - "install_dir", - metavar="INSTALL_DIR", - type=Path, - default=None, - help="installation directory of Mod Organizer 2", - ) - parser.add_argument( - "-p", "--private", action="store_true", help="also load the moprivate module" - ) - - args = parser.parse_args() - - if args.private: - mobase, moprivate = load_mobase(args.install_dir, moprivate=True) - else: - mobase = load_mobase(args.install_dir) diff --git a/generator/mtypes.py b/generator/mtypes.py deleted file mode 100644 index 64ade1a..0000000 --- a/generator/mtypes.py +++ /dev/null @@ -1,627 +0,0 @@ -# -*- encoding: utf-8 -*- - -from typing import Optional, List, Any, Dict, Union - -from . import logger -from . import utils - - -class Type: - """ Class representing a python type. """ - - # The `MoVariant` actual type - This should be List["MoVariant"] and - # Dict[str, "MoVariant"], but mypy (and other type checkers) do not - # handle recursive definition yet: - MO_VARIANT = """Union[None, bool, int, str, List[Any], Dict[str, Any]]""" - - name: str - - def __init__(self, name: Union[str, type]): - # Import only here since we change the path to find them: - from PyQt5 import QtCore, QtGui, QtWidgets - - if isinstance(name, type): - name = name.__name__ - - self.name = name.strip() - - # We replace QVariant with MoVariant which is valid python type: - if self.name == "QVariant": - self.name = "MoVariant" - - # Find PyQt types: - for m in (QtCore, QtGui, QtWidgets): - if self.name in dir(m): - self.name = "{}.{}".format(m.__name__, self.name) - - def typing(self, settings: utils.Settings) -> str: - """ Returns a valid typing representation for this type. """ - from .register import MOBASE_REGISTER - - # Check if this is a mobase object, in which case we escape: - if self.name in MOBASE_REGISTER.objects: - return '"{}"'.format(self.name) - - # Check in existing objects (also inner classes) - This may cause - # issue with conflicts, but those should not be present: - for k in MOBASE_REGISTER.objects: - if k.split(".")[-1] == self.name: - return '"{}"'.format(k) - - return self.name - - def is_none(self) -> bool: - """ Check if this type represent None. """ - return self.name.lower() in ("none", "nonetype") - - def is_object(self) -> bool: - """ Check if this type represent the generic "object" type. """ - return self.name.lower() == "object" - - def is_any(self) -> bool: - """ Check if this type repesent the typing "Any". """ - return self.name == "Any" - - def __str__(self): - return "Type({})".format(self.name) - - def __repr__(self): - return str(self) - - def __hash__(self): - return hash(self.name) - - def __eq__(self, other: object) -> bool: - if not isinstance(other, Type): - return NotImplemented - return self.name == other.name - - -class CType(Type): - """ Class representing a C++ type from boost::python. """ - - # List of smart pointer types - Not including pointer that should not - # be exposed (unique_ptr, weak_ptr): - SMART_POINTERS = ["std::shared_ptr", "boost::shared_ptr", "QSharedPointer"] - - # Standard conversions (usually, the python signature is sufficient for - # those, unless we found them inside a tuple): - STANDARD_TYPES = { - "short": "int", - "int": "int", - "long": "int", - "float": "float", - "double": "float", - } - - # Replacements for typing (without warnings): - REPLACEMENTS = { - "QString": "str", - "QStringList": "List[str]", - "QWidget *": "PyQt5.QtWidgets.QWidget", - "QMainWindow *": "PyQt5.QtWidgets.QMainWindow", - "QObject *": "PyQt5.QtCore.QObject", - "void *": "object", - "api::object": "object", - } - - _optional: bool - - def __init__(self, name: str, optional: bool = False): - super().__init__(name) - self._optional = optional - - def _is_not_valid(self, str): - for x in str: - if x in "<>():*": - return True - return False - - def _try_fix(self, name, settings: utils.Settings): - - from .parser import parse_ctype, magic_split, parse_csig - from .register import MOBASE_REGISTER - - pname = name - - # Unconverted QFlags are int in python: - if name.startswith("QFlags"): - name = "int" - - # If pointer, try to fix the corresponding python name: - if self.is_pointer(): - - newname: Optional[str] = None - - # For display purpose: - optstr = "" - if self.is_optional(): - optstr = " [optional]" - - # Check if there is a type registered: - if self.name in MOBASE_REGISTER.cpp2py: - newtype = MOBASE_REGISTER.cpp2py[self.name] - - if newtype.is_object(): - logger.critical( - ( - "Found {} pointer but did not found any corresponding " - "python type, the interface is likely missing." - ).format(name) - ) - return "InterfaceNotImplemented" - - if self._is_builtin_python_type(newtype): - logger.critical( - "Found {} which is a pointer to a built-in python type.".format( - self.name - ) - ) - return "InterfaceNotImplemented" - - newname = newtype.name - - # Note: No WARNING here as this is safe: - logger.info("Replacing {} with {}{}.".format(name, newname, optstr)) - - # "Tricky" fix for pointer raw pointer and smart pointers: - elif self.is_raw_pointer(): - newname = name.strip("*").replace("const", "").strip() - logger.warning("Replacing {} with {}{}.".format(name, newname, optstr)) - - else: - for ptr in self.SMART_POINTERS: - if name.startswith(ptr): - newname = name[len(ptr) :][1:-1].replace("const", "").strip() - logger.warning( - "Replacing {} with {}{}.".format(name, newname, optstr) - ) - - if newname is not None: - if self.is_optional(): - if newname in MOBASE_REGISTER.py2cpp: - newname = '"{}"'.format(newname) - return "Optional[{}]".format(newname) - else: - return newname - - # Variant: - for c in ("boost::variant", "std::variant"): - if name.startswith(c): - name = name[len(c) :].strip()[1:-1].strip() - args = [parse_ctype(c).typing(settings) for c in magic_split(name)] - name = "Union[{}]".format(", ".join(args)) - - for c in ( - "std::vector", - "std::set", - "std::unordered_set", - "std::list", - "QList", - "QVector", - "QSet", - ): - if name.startswith(c): - name = name[len(c) :].strip()[1:-1].strip() - arg = parse_ctype(magic_split(name)[0]).typing(settings) - name = "List[{}]".format(arg) - - for c in ("std::map", "std::unordered_map", "QMap"): - if name.startswith(c): - name = name[len(c) :].strip()[1:-1].strip() - a1, a2 = [ - parse_ctype(x).typing(settings) for x in magic_split(name)[:2] - ] - name = "Dict[{}, {}]".format(a1, a2) - - for c in ("boost::tuples::tuple", "std::tuple"): - if name.startswith(c): - name = name[len(c) :].strip()[1:-1].strip() - args = [parse_ctype(c).typing(settings) for c in magic_split(name)] - args = [a for a in args if a != "boost::tuples::null_type"] - name = "Tuple[{}]".format(", ".join(args)) - - # Fix for function... - if name.startswith("std::function"): - name = name[13:].strip()[1:-1].strip() - rtype, vargs = parse_csig(name, "") - name = "Callable[[{}], {}]".format( - ", ".join(a.type.typing(settings) for a in vargs), - rtype.typing(settings), - ) - - if name.find("::") != -1: - parts = name.split("::") - - # We are going to check if there is an exact python match for - # this class (replacing :: by .): - if parts[0] in MOBASE_REGISTER.py2cpp: - cp: List[Class] = [MOBASE_REGISTER.objects[parts[0]]] # type: ignore - for p in parts[1:]: - for ic in cp[-1].inner_classes: - if ic.name == p: - cp.append(ic) - break - if len(cp) == len(parts): - name = '"' + ".".join(parts) + '"' - - if pname != name: - logger.info("Fixed {} to {}. ".format(pname, name)) - else: - logger.critical( - "Failed to fix {}, a custom rule is probably required.".format(name) - ) - - return name - - def _is_builtin_python_type(self, t: Type): - """Check if the given type is a 'raw' python type, i.e., a type that cannot - be a C++ reference. This is mainly used to report errors when pointers to such - type are present in the interface.""" - return t.name in ["bool", "int", "float", "str", "list", "std", "dict", "bytes"] - - def typing(self, settings: utils.Settings) -> str: - """ Returns a valid typing representation for this type. """ - from .register import MOBASE_REGISTER - - name = self.name - - if self.is_none(): - return "None" - - if name in CType.STANDARD_TYPES: - name = CType.STANDARD_TYPES[name] - - if name in CType.REPLACEMENTS: - name = CType.REPLACEMENTS[name] - - if name in settings.replacements: - logger.warning( - "Replacing {} with {}.".format(name, settings.replacements[name]) - ) - name = settings.replacements[name] - - # If the name contains stuff that should not be there, try some - # "magic" conversion: - if self._is_not_valid(name): - name = self._try_fix(name, settings) - - if name in MOBASE_REGISTER.objects: - name = '"{}"'.format(name) - - return name - - def is_raw_pointer(self) -> bool: - """ Check if this type is a raw pointer type. """ - return self.name.endswith("*") - - def is_smart_pointer(self) -> bool: - """ Check if this type is a smart pointer type. """ - - for ptr in self.SMART_POINTERS: - if self.name.startswith(ptr): - return True - - return False - - def is_pointer(self) -> bool: - """ Check if this type corresponds to a pointer type. """ - return self.is_raw_pointer() or self.is_smart_pointer() - - def is_optional(self) -> bool: - """ Check if this type is optional (i.e., can be None in python). """ - return self._optional - - def is_none(self) -> bool: - """ Check if this type represent None. """ - return self.name.lower() == "void" - - def is_object(self) -> bool: - """ Check if this type represent the generic "object" type """ - return self.name.lower() == "_object *" - - def __str__(self) -> str: - return "CType({})".format(self.name) - - def __repr__(self) -> str: - return str(self) - - -class Ret: - """ Class representing the return value of a function (type and documentation). """ - - type: Type - doc: str - - def __init__(self, type: Type, doc: str = ""): - self.type = type - self.doc = doc - - -class Arg: - """ Class representing a function argument (type and eventual default value). """ - - # Constant representing None since None indicates no default value: - DEFAULT_NONE = "None" - - name: str - type: Type - _value: Optional[str] - doc: str - - def __init__( - self, name: str, type: Type, value: Optional[str] = None, doc: str = "" - ): - self.name = name - self.type = type - self._value = value - self.doc = doc - - @property - def value(self) -> Optional[str]: - - value = self._value - - if value is None: - return None - - # Boost has a tendency to put `mobase.` in front of default values... - if value is not None and value.startswith("mobase."): - value = value[7:] - - return value - - def has_default_value(self) -> bool: - return self.value is not None - - def __str__(self): - if self.has_default_value(): - return "Arg({}={})".format(self.type, self.value) - return "Arg({})".format(self.type) - - def __repr__(self): - return str(self) - - def __hash__(self): - return hash(self.type) - - def __eq__(self, other: object) -> bool: - if not isinstance(other, Arg): - return NotImplemented - return self.type == other.type - - -class Exc: - - """ Small class representing exception that can be raised from functions. """ - - type: Type - doc: str - - def __init__(self, type: Type, doc: str = ""): - self.type = type - self.doc = doc - - -class Function: - """ Class representing a function. """ - - name: str - ret: Ret - args: List[Arg] - overloads: bool - raises: List[Exc] - doc: str - deprecated: bool - - def __init__( - self, - name: str, - ret: Ret, - args: List[Arg], - has_overloads: bool = False, - doc: str = "", - ): - self.name = name - self.ret = ret - self.args = args - self.overloads = has_overloads - self.raises = [] - self.doc = "" - self.deprecated = False - - def has_overloads(self): - return self.overloads - - def is_deprecated(self): - return self.deprecated - - -class Method(Function): - """ Class representing a method. """ - - cls: "Class" - abstract: Union[str, bool] - static: bool - - def __init__( - self, - name: str, - ret: Ret, - args: List[Arg], - static: bool, - has_overloads: bool = False, - doc: str = "", - ): - super().__init__(name, ret, args, has_overloads, doc) - self.static = static - self.abstract = "auto" - - def is_abstract(self): - if self.name.startswith("__"): - return False - if self.abstract == "auto": - return self.cls.is_abstract() - return self.abstract - - def is_static(self): - return self.static - - def is_special(self): - return self.name.startswith("__") - - def is_constructor(self): - return self.name == "__init__" - - -class Constant: - """ Class representing a constant. """ - - name: str - type: Optional[Type] - value: Any - doc: Optional[str] - - def __init__( - self, name: str, type: Optional[Type], value: Any, doc: Optional[str] = None - ): - self.name = name - self.type = type - - # Note: The value is not used actually since we can hide it using `...`. - self.value = value - self.doc = doc - - -class Property: - """ Class representing a property. """ - - name: str - type: Type - doc: str - read_only: bool - - def __init__(self, name: str, type: Type, read_only: bool, doc: str = ""): - self.name = name - self.type = type - self.read_only = read_only - self.doc = doc - - def is_read_only(self): - return self.read_only - - -class Class: - """ Class representing a class. """ - - name: str - bases: List["Class"] - methods: List[Method] - constants: List[Constant] - properties: List[Property] - inner_classes: List["Class"] - outer_class: Optional["Class"] - doc: str - abstract: bool - deprecated: bool - - def __init__( - self, - name: str, - bases: List["Class"], - methods: List[Method], - constants: List[Constant] = [], - properties: List[Property] = [], - inner_classes: List["Class"] = [], - doc: str = "", - ): - - self.name = name - self.bases = bases - self.methods = methods - self.properties = properties - self.constants = constants - self.inner_classes = inner_classes - self.doc = "" - self.abstract = False - self.outer_class = None - self.deprecated = False - - # Update class in method: - for m in self.methods: - m.cls = self - for ic in self.inner_classes: - ic.outer_class = self - - def is_abstract(self): - """ - Returns: - True if this class is abstract, False otherwise. - """ - return self.abstract or any(bc.is_abstract() for bc in self.bases) - - @property - def canonical_name(self): - """ Return the canonical name of this class. """ - name = self.name - oc = self.outer_class - while oc is not None: - name = "{}.{}".format(oc.name, name) - oc = oc.outer_class - - return name - - @property - def all_bases(self): - """ - Returns: - All the bases of this class, including bases of bases and so on. - """ - bases = set(self.bases) - for b in self.bases: - bases = bases.union(b.all_bases) - return bases - - def is_deprecated(self): - return self.deprecated - - def __str__(self): - return self.canonical_name - - -class PyClass(Class): - - """Class use to wrap Python class to be used as parent class for some classes - in mobase.""" - - def __init__( - self, name: str, - ): - super().__init__(name, [], []) - self.abstract = False - - -class Enum(Class): - """ Class representing an enum. """ - - def __init__(self, name: str, values: Dict[str, int]): - # Note: Boost.Python.enum inherits int() not enum.Enum() but for the sake - # of stubs, I think making them inherit enum.Enum is more appropriate: - super().__init__( - name, - [PyClass("Enum")], - [ - Method( - "__{}__".format(mname), - Ret(Type(bool)), - [Arg("", Type(name)), Arg("other", Type(int))], - static=False, - ) - for mname in ["and", "or", "rand", "ro"] - ], - inner_classes=[], - constants=[Constant(k, None, v) for k, v in values.items()], - ) - - def is_abstract(self): - return False diff --git a/generator/parser.py b/generator/parser.py deleted file mode 100644 index 80c9ffc..0000000 --- a/generator/parser.py +++ /dev/null @@ -1,596 +0,0 @@ -# -*- encoding: utf-8 -*- - -import inspect -import re - -from collections import defaultdict, OrderedDict - -from typing import List, Tuple, Optional, Dict, Union - -from .register import MobaseRegister -from .mtypes import ( - Type, - CType, - Class, - PyClass, - Enum, - Arg, - Ret, - Method, - Constant, - Property, - Function, -) -from . import logger - - -def magic_split(value: str, sep=",", open="(<", close=")>"): - """Split the value according to the given separator, but keeps together elements - within the given separator. Useful to split C++ signature function since type names - can contain special characters... - - Examples: - - magic_split("a,b,c", sep=",") -> ["a", "b", "c"] - - magic_split("a,d(e,),p) -> ["a", "d(e,)", "p"] - - Args: - value: String to split. - sep: Separator to use. - open: List of opening characters. - close: List of closing characters. Order must match open. - - Returns: The list of split parts from value. - """ - i, j = 0, 0 - s: List[str] = [] - r = [] - while i < len(value): - j = i + 1 - while j < len(value): - c = value[j] - - # Separator found and the stack is empty: - if c == sep and not s: - break - - # Check close/open: - if c in open: - s.append(open.index(c)) - elif c in close: - # The stack might be empty if the separator is also an opening element: - if not s and sep in open and j + 1 == len(value): - pass - else: - t = s.pop() - if t != close.index(c): - raise ValueError( - "Found closing element {} for opening element {}.".format( - c, open[t] - ) - ) - j += 1 - r.append(value[i:j]) - i = j + 1 - - return r - - -def parse_ctype(s: str) -> CType: - """Parse a C++ type from the given string. - - Args: - s: String to parse. - - Returns: A C++ type parsed from the given string. - """ - - # List of strings that can be removed from the names: - for d in [ - "__64", - "__cdecl", - "__ptr64", - "{lvalue}", - "class", - "struct", - "enum", - "unsigned", - ]: - s = s.replace(d, "") - - # Remove the namespace remaing: - for d in ["MOBase", "boost::python"]: - s = s.replace(d + "::", "") - - # Specific replacement: - s = s.replace("__int64", "int") - s = s.replace(" const &", "") - s = s.replace("&", "") - - return CType(s.strip()) - - -def parse_carg(s: str, has_default: bool) -> Arg: - """Parse the given C++ argument. - - Args: - s: The string to parse. - has_default: Indicates if this argument as a default. - - Returns: An argument parsed from the given string. - """ - v, d = s, None - if s.find("=") != -1: - v, d = [x.strip() for x in s.split("=")] - - if d is None and has_default: - d = Arg.DEFAULT_NONE - - return Arg("", parse_ctype(v), d) - - -def parse_csig(s, name) -> Tuple[CType, List[Arg]]: - """Parse a boost::python C++ signature. - - Args: - s: The signature to parse. - name: Name of the function, or "" if the signature correspond to a type. - - Returns: (RType, Args) where RType is a CType object, and Args is a list of Arg - objects containing CType. - """ - # Remove the [ and ] which specifies default arguments but are useless since - # we already have = to tell us - The replacement is weird because the way boost - # present these is weird, and to avoid breaking default argument such as = []: - c = s.count("[,") - s = s.replace("[,", ",") - s = s.replace("]" * c, "") - - # Split return type/arguments: - if name: - rtype_s, args_s = s.split(name) - - # Remove the ( and ). - args_s = args_s.strip()[1:-1] - else: - rtype_s, args_s = magic_split(s, "(", "(<", ")>") - - # Only remove the last ) because the first one is removed by magic_split: - args_s = args_s.strip()[:-1] - - # Parse return type: - rtype = parse_ctype(rtype_s.strip()) - - # Parse arguments: - - # Strip spaces and remove the first and last (): - args_s = args_s.strip() - args_ss = magic_split(args_s, ",", "(<", ")>") - args = [parse_carg(v, i > len(args_ss) - c - 1) for i, v in enumerate(args_ss)] - - return rtype, args - - -def parse_psig(s: str, name: str) -> Tuple[Type, List[Arg]]: - """Parse a boost::python python signature. - - Args: - s: The signature to parse. - name: Name of the function. - - Returns: (RType, Args) where RType is a Type object, and Args is a list of Arg - objects containing Type. - """ - - c = s.count("[,") - s = s.replace("[,", ",") - s = s.replace("]" * c, "") - - # This is pretty brutal way of extracting stuff... But most things can be - # retrieve from the C++ signature, here we are mainly interested in extracting - # the python type if possible: - m: re.Match[str] = re.search( - r"{}\((.*)\)\s*->\s*([^\s]+)\s*:".format(name), s - ) # type: ignore - pargs = [] - args = list(filter(bool, m.group(1).strip().split(","))) - for i, pa in enumerate(args): - pa = pa.strip() - - # Index of the right bracket: - irbrack = pa.find(")") - - # The type is within the brackets: - t = pa[1:irbrack] - - pa = pa[irbrack + 1 :] - n: str = pa.strip() - d: Optional[str] = None - if pa.find("=") != -1: - n, d = pa.split("=") - n = n.strip() - d = d.strip() - elif i > len(args) - c - 1: - d = Arg.DEFAULT_NONE - pargs.append(Arg(n, Type(t), d)) - return Type(m.group(2)), pargs - - -def find_best_argname(iarg: int, pname: str, cname: str): - """Find the best name for the ith argument of a function. - - Args: - iarg: Index of the argument, use for default. - pname: Name of the argument in the python signature. - cname: Name of the argument in the C++ signature. - - Returns: - The best name for the corresponding argument. - """ - if not cname and not pname: - return "arg{}".format(iarg + 1) - - return pname - - -def find_best_type(ptype: Type, ctype: CType) -> Type: - """Find the best type from the given python and C++ type. - - - Args: - ptype: The python type. - ctype: The C++ type. - - Returns: The best of the two types. - """ - from .register import MOBASE_REGISTER - - if ptype.name == ctype.name: - return ptype - elif ptype.is_none() and ctype.is_none(): - return ptype - - assert ptype.is_none() == ctype.is_none() - - MOBASE_REGISTER.register_type(ptype, ctype) - - if ptype.is_object(): - if ctype.is_object(): - return ptype - return ctype - - # Returned pointer are treated differently because they can often be null: - if ctype.is_pointer(): - return ctype - - return ptype - - -def find_best_value(pvalue: str, cvalue: str) -> str: - """Find the best value (default value) from the given python and C++ one. - - WARNING: This currently always return pvalue and only warns the user if - the two values are not identical. - - Args: - pvalue: Python default value. - cvalue: C++ default value. - - Returns: The best of the two values. - """ - if pvalue != cvalue: - logger.warning("Mismatch default value: {} {}.".format(pvalue, cvalue)) - return pvalue - - -def is_enum(e: type) -> bool: - """Check if the given class is an enumeration. - - Args: - e: The class object to check. - - Returns: True if the object is an enumeration (boost::python enumeration, not - python) False otherwize. - """ - # Yet to find a better way... - if not isinstance(e, type): - return False - return any( - "{}.{}".format(c.__module__, c.__name__) == "Boost.Python.enum" - for c in inspect.getmro(e) - ) - - -def make_enum(fullname: str, e: type) -> Enum: - """Construct a Enum object from the given class. - - Args: - fullname: Fully qualified name of the enumeration. - e: The class representing a boost::python enumeration. - - Returns: An Enum object representing the given enumeration. - """ - # All boost enums have a .values attributes: - values = e.values # type: ignore - - return Enum( - e.__name__, OrderedDict((values[k].name, k) for k in sorted(values.keys())), - ) - - -class Overload: - - """ Small class to avoid mypy issues... """ - - rtype: Type - args: List[Arg] - - def __init__(self, rtype, args): - self.rtype = rtype - self.args = args - - -def parse_bpy_function_docstring(e) -> List[Overload]: - """Parse the docstring of the given element. - - Args: - e: The function to "parse". - - Returns: A list of overloads for the given function, where each overload is - a dictionary with a "rtype" entry containing the return type and a "args" - entry containing the list of arguments. - """ - lines = e.__doc__.split("\n") - - # Find the various overloads: - so = [i for i, line in enumerate(lines) if line.strip().startswith(e.__name__)] - so.append(len(lines)) - - # We are going to parse the python and C++ signature, and try to merge - # them... - overloads: List[Overload] = [] - for i, j in zip(so[:-1], so[1:]): - - psig = lines[i].strip() - for k in range(i, j): - if lines[k].strip().startswith("C++ signature"): - csig = lines[k + 1].strip() - - prtype, pargs = parse_psig(psig, e.__name__) - crtype, cargs = parse_csig(csig, e.__name__) - - # Currently there is no way to automatically check so we add [optional] - # in the doc: - if e.__doc__.find("[optional]") != -1: - crtype._optional = True - - assert len(pargs) == len(cargs) - - # Now we need to find the "best" type from both signatures: - rtype = find_best_type(prtype, crtype) - args = [] - for iarg, (parg, carg) in enumerate(zip(pargs, cargs)): - args.append( - Arg( - find_best_argname(iarg, parg.name, carg.name), - find_best_type(parg.type, carg.type), # type: ignore - find_best_value(parg.value, carg.value), # type: ignore - ) - ) # type: ignore - - overloads.append(Overload(rtype=rtype, args=args)) - - return overloads - - -def make_functions(name: str, e) -> List[Function]: - overloads = parse_bpy_function_docstring(e) - - return [ - Function( - e.__name__, Ret(ovld.rtype), ovld.args, has_overloads=len(overloads) > 1, - ) - for ovld in overloads - ] - - -def make_class(fullname: str, e: type, register: MobaseRegister) -> Class: - """Constructs a Class objecgt from the given python class. - - Args: - fullname: Name of the class (might be different from __name__ for inner - classes). - e: The python class (created from boost) to construct an object for. - class_register: - - Returns: A Class object corresponding to the given class. - """ - - base_classes_s: List[str] = [] - - # Kind of ugly, but...: - for c in inspect.getmro(e): - if c != e and c.__module__ == "mobase": - base_classes_s.append(c.__name__) - if c.__module__ == "Boost.Python": - break - - # Keep as a comment but this is/should be fixed in the actual C++ code: - # Lots of class exposed do not inherit IPlugin while they should: - # if "IPlugin" not in base_classes_s and e.__name__.startswith("IPlugin") \ - # and e.__name__ != "IPlugin": - # base_classes_s.append("IPlugin") - - # This contains ALL the parent classes, not the direct ones: - base_classes: List[Class] = [ - register.make_object(name) for name in base_classes_s # type: ignore - ] - - # Retrieve all the attributes... The hasattr is required but I don't know why: - all_attrs = [(n, getattr(e, n)) for n in dir(e) if hasattr(e, n)] - - # Some exclusions: - EXCLUDED_MEMBERS = [ - "__weakref__", - "__dict__", - "__doc__", - "__instance_size__", - "__module__", - "__getattr__", - ] - all_attrs = [ - a - for a in all_attrs - # Using getattr() here since some attribute do not have name (e.g. constants): - if a[0] not in EXCLUDED_MEMBERS - ] - - # Fetch all attributes from the base classes: - base_attrs: Dict[str, List[Union[Constant, Property, Method, Class]]] = defaultdict( - list - ) - for bc in base_classes: - # Thanks mypy for the naming... - for a1 in bc.constants: - base_attrs[a1.name].append(a1) - for a2 in bc.methods: - base_attrs[a2.name].append(a2) - for a3 in bc.properties: - base_attrs[a3.name].append(a3) - for a4 in bc.inner_classes: - base_attrs[a4.name].append(a4) - - # Retrieve the enumerations and classes: - inner_classes = [ - ic[1] - for ic in all_attrs - if isinstance(ic[1], type) - and ic[1].__name__ != "class" - and ic[0] not in base_attrs - ] - - pinner_classes: List[Class] = [ - register.make_object("{}.{}".format(fullname, ic.__name__), ic) # type: ignore - for ic in inner_classes - ] - - # Find the methods: - methods = [m[1] for m in all_attrs if callable(m[1])] - methods = sorted(methods, key=lambda m: m.__name__) - - # Filter out methods not provided or implemented: - methods = [ - m - for m in methods - if m.__doc__ is not None and m.__doc__.find("C++ signature") != -1 - ] - - # List of methods that must return bool: - BOOL_METHODS = ["__eq__", "__lt__", "__le__", "__ne__", "__gt__", "__ge__"] - - pmethods = [] - for method in methods: - if method.__doc__ is None: - continue - overloads = parse_bpy_function_docstring(method) - - # __eq__ must accept an object in python, so we need to add an overload: - if method.__name__ in ["__eq__", "__ne__"]: - overloads.append( - Overload( - rtype=Type("bool"), - args=[Arg("", Type(e.__name__)), Arg("other", Type("object"))], - ) - ) - - cmethods = [] - for ovld in overloads: - args = ovld.args - - # This is a very heuristic way of checking if the method is static but I did - # not find anything better yet... - static = False - if len(args) == 0: - static = True - elif method.__name__.startswith("__"): # Special method cannot be static - static = False - else: - arg0_name = args[0].type.name - if arg0_name in register.cpp2py: - arg0_name = register.cpp2py[arg0_name].name - arg0_name = ( - arg0_name.replace("*", "") - .replace("&", "") - .replace("const", "") - .strip() - ) - - static = ( - arg0_name - not in [e.__name__, e.__name__ + "Wrapper"] + base_classes_s - ) - - # We need to fix some default values (basically default values that - # comes from inner enum): - for arg in ovld.args: - if arg.has_default_value(): - value: str = arg.value # type: ignore - bname = value.split(".")[0] - for bclass in base_classes: - for biclass in bclass.inner_classes: - if isinstance(biclass, Enum) and biclass.name == bname: - arg._value = bclass.name + "." + value - - pmethod = Method( - method.__name__, - Ret(ovld.rtype), - ovld.args, - static=static, - has_overloads=len(overloads) > 1, - ) - - if method.__name__ in BOOL_METHODS: - pmethod.ret = Ret(Type("bool")) - - cmethods.append(pmethod) - - pmethods.extend(cmethods) - - # Retrieve the attributes: - constants = [] - properties = [] - for name, attr in all_attrs: - if callable(attr) or isinstance(attr, type): - continue - - # Maybe we should check an override here (e.g., different value for a constant): - if name in base_attrs: - continue - - if isinstance(attr, property): - properties.append(Property(name, Type("Any"), attr.fset is None)) - elif not hasattr(attr, "__name__"): - constants.append(Constant(name, Type(type(attr).__name__), attr)) - - direct_bases: List[Class] = [] - for c in e.__bases__: - if c.__module__ != "Boost.Python": - direct_bases.append(register.get_object(c.__name__)) - - # Forcing QWidget base for XWidget classes since these do not show up - # and we use a trick: - if e.__name__.endswith("Widget"): - logger.info( - "Forcing base {} for class {}.".format( - "PyQt5.QtWidgets.QWidget", e.__name__ - ) - ) - direct_bases.append(PyClass("PyQt5.QtWidgets.QWidget")) - - return Class( - e.__name__, - direct_bases, - pmethods, - inner_classes=pinner_classes, - properties=properties, - constants=constants, - ) diff --git a/generator/register.py b/generator/register.py deleted file mode 100644 index 3339bc3..0000000 --- a/generator/register.py +++ /dev/null @@ -1,106 +0,0 @@ -# -*- encoding: utf-8 -*- - -from collections import OrderedDict -from typing import Optional, Dict, Union, List - -from . import logger -from .mtypes import Class, Type, CType, Function - - -class MobaseRegister: - """ Class that register class. """ - - objects: Dict[str, Union[Class, List[Function]]] - - def __init__(self): - """ Create a new register with the list of objects. """ - self.raw_objects: Dict[str, Union[type]] = OrderedDict() - self.objects = {} - - self._cpptypes = {} - self.cpp2py = {} - - def add_object(self, name, object): - self.raw_objects[name] = object - - def make_object( - self, name: str, e: Optional[type] = None - ) -> Union["Class", List["Function"]]: - """Construct a Function, Class or Enum for the given object. - - Args: - name: The name of the object to inspect. - e: The object to inspect, or None to fetch it from the underlying list. - - Returns: A Class object for the given type, or a list of function overloads. - """ - from .parser import make_enum, make_class, is_enum, make_functions - - if e is None: - e = self.raw_objects[name] - - if name not in self.raw_objects: - self.raw_objects[name] = e - - if name not in self.objects: - if is_enum(e): - self.objects[name] = make_enum(name, e) - elif isinstance(e, type): - self.objects[name] = make_class(name, e, self) - elif callable(e): - self.objects[name] = make_functions(name, e) - - return self.objects[name] - - def get_object(self, name: str): - """ - Retrieve the object if the given name. Fails if no object with this - name exists (if `make_object(name, ...)` has never been called). - - Args: - name: Name of the object to retrieve. - - Returns: - The object with the given name. - """ - return self.objects[name] - - def register_type(self, ptype: "Type", ctype: "CType"): - """Register an equivalence between a python name and a C++ name. - - Args: - python_name: Name of the Python class. - cpp_name: Name of the C++ class. - """ - # Register the const equivalent for smart pointers: - cname = ctype.name - if ctype.is_smart_pointer(): - if cname.find(" const >") != -1: - c2name = cname.replace(" const >", ">") - if c2name in self._cpptypes: - ptype = self.cpp2py[c2name] - # Not the const, replace the const one: - else: - c2name = cname.replace(">", " const >") - if c2name in self._cpptypes and self.cpp2py[c2name].is_object(): - self._cpptypes[c2name] = ctype - self.cpp2py[c2name] = ptype - logger.warning( - "Replace registration {} [c++] with {} [python] using {}" - " information.".format(c2name, ptype.name, cname) # noqa: E501 - ) - - if cname not in MOBASE_REGISTER.cpp2py: - self._cpptypes[cname] = ctype - self.cpp2py[cname] = ptype - logger.info("Registered {} [c++] as {} [python].".format(cname, ptype.name)) - - @property - def py2cpp(self): - result = {v.name: [] for v in self.cpp2py.values()} - for k in self.cpp2py: - result[self.cpp2py[k].name].append(self._cpptypes[k]) - return result - - -MOBASE_REGISTER = MobaseRegister() diff --git a/generator/utils.py b/generator/utils.py deleted file mode 100644 index 8a18986..0000000 --- a/generator/utils.py +++ /dev/null @@ -1,486 +0,0 @@ -# -*- encoding: utf-8 -*- - -from collections import OrderedDict, defaultdict -from typing import List, Dict, Any, Tuple, TextIO, Optional, Union, NamedTuple, Set - -from . import logger -from . import register -from . import mtypes - -import yaml - - -class Settings: - class FunctionSettings(NamedTuple): - - doc: str - args: Optional[List["mtypes.Arg"]] = None - ret: Optional["mtypes.Ret"] = None - raises: List["mtypes.Exc"] = [] - static: Optional[bool] = None - abstract: Optional[bool] = None - deprecated: bool = False - - register: "register.MobaseRegister" - - # Name to ignore: - _ignore_names: List[str] - - # Extra replacements (with warnings): - _replacements: Dict[str, str] - - # Content of mobase: - _mobase: Dict[str, Dict[str, Any]] - - def __init__( - self, register: "register.MobaseRegister", fp: Optional[TextIO] = None - ): - - self.register = register - - if fp is None: - self._ignore_names = [] - self._replacements = {} - self._mobase = {} - else: - data = yaml.load(fp, yaml.FullLoader) - assert data["version"] == 1 - - self._ignore_names = data.get("ignores", []) - self._replacements = data.get("replacements", {}) - self._mobase = data.get("mobase", {}) - - @property - def ignore_names(self) -> List[str]: - return self._ignore_names - - @property - def replacements(self) -> Dict[str, str]: - return self._replacements - - @property - def mobase(self) -> Dict[str, Dict[str, Any]]: - return self._mobase - - def _get_class_settings(self, canonical_name: str) -> Optional[Dict[str, Any]]: - """Retrieve the settings for the given class. - - Args: - canonical_name: Canonical name of the class. - - Returns: - The settings for the corresponding class, or None if the - settings where not found. - """ - parts = canonical_name.split(".") - base: Dict[str, Any] = self._mobase - for part in parts: - if part in base: - base = base[part] - else: - return None - return base - - def _parse_function_settings( - self, settings: Union[str, Dict[str, Any]] - ) -> "FunctionSettings": - """Parse settings for a function or method. - - Args: - settings: Settings corresponding to a function. - - Returns: - The parsed settings for the function. - """ - FunctionSettings = Settings.FunctionSettings - - if settings is None: - return FunctionSettings("") - - if isinstance(settings, str): - return FunctionSettings(settings) - - doc = settings.get("__doc__", "") - static = settings.get("static", None) - abstract = settings.get("abstract", None) - deprecated = settings.get("deprecated", False) - - # Arguments: - args: Optional[List[mtypes.Arg]] = None - - # If "args" is in settings, it can either be None (args: ) or - # a list of args: - if "args" in settings: - args = [] - if settings["args"] is not None: - - # For each argument, we either have a None value (name: ), - # or a string (name: Description) or a dictionary that can contain - # __doc__ and type. - for aname, avalue in settings["args"].items(): - t: mtypes.Type = mtypes.Type("None") - d: str = "" - if avalue is None: - pass - elif isinstance(avalue, str): - d = avalue - else: - d = avalue.get("__doc__", "") - t = mtypes.Type(avalue.get("type", "None")) - args.append(mtypes.Arg(aname, t, doc=d)) - - ret: Optional[mtypes.Ret] = None - if "returns" in settings and settings["returns"] is not None: - if isinstance(settings["returns"], str): - ret = mtypes.Ret(mtypes.Type("None"), settings["returns"]) - else: - ret = mtypes.Ret( - mtypes.Type(settings["returns"].get("type", "None")), - settings["returns"].get("__doc__", ""), - ) - - excs: List[mtypes.Exc] = [] - if "raises" in settings and settings["raises"] is not None: - for r, v in settings["raises"].items(): - if v is None: - v = "" - excs.append(mtypes.Exc(mtypes.Type(r), v)) - - return FunctionSettings(doc, args, ret, excs, static, abstract, deprecated) - - def patch_functions(self, fns: List["mtypes.Function"]): - for i, fn in enumerate(fns): - - # Find the name in settings: - if fn.has_overloads(): - sname = "{}.{}".format(fn.name, i + 1) - else: - sname = fn.name - - # If the name is in the settings: - if sname in self._mobase: - fsettings = self._parse_function_settings(self._mobase[sname]) - - # Force raises: - fn.raises = fsettings.raises - - # Check the args: - if fsettings.args is not None: - if len(fsettings.args) != len(fn.args): - logger.warn( - "Mismatch number of arguments for function mobase.{}." - .format(sname) # noqa - ) - - for sarg, marg in zip(fsettings.args, fn.args): - marg.doc = sarg.doc - if not sarg.type.is_none(): - marg.type = sarg.type - - # Check the return type: - if fsettings.ret is not None: - - # Force the doc anyway: - fn.ret.doc = fsettings.ret.doc - - # Update the type if specified: - if not fsettings.ret.type.is_none(): - fn.ret.type = fsettings.ret.type - - # Force the doc: - fn.doc = fsettings.doc - - # Force depreciation: - fn.deprecated = fsettings.deprecated - - else: - logger.warn("Missing settings for function mobase.{}.".format(sname)) - - def patch_class(self, cls: "mtypes.Class"): - """Patch the given class using the given overwrites. - - See config.json for some examples of valid overwrites. - - Args: - cls: The class to patch. - settings: The settings. - """ - - logger.info("Patching class {}.".format(cls.name)) - - # Find the class in mobase: - csettings = self._get_class_settings(cls.canonical_name) - - if csettings is None: - logger.warn("Class {} not found in settings.".format(cls.canonical_name)) - return - - if "__doc__" in csettings and csettings["__doc__"] is not None: - cls.doc = csettings["__doc__"] - csettings.pop("__doc__", None) - - # Check bases: - if "__bases__" in csettings: - for bc in csettings["__bases__"]: - if bc.startswith("PyQt"): - cls.bases.append(mtypes.PyClass(bc)) - else: - cls.bases.append(self.register.get_object(bc)) - del csettings["__bases__"] - - if "__abstract__" in csettings and csettings["__abstract__"]: - cls.abstract = True - del csettings["__abstract__"] - - # Patch properties - Everything should be in config since property are poorly - # documented by boost::python. - properties: Dict[str, Any] = csettings.pop("properties[]", {}) - for prop in cls.properties: - if prop.name in properties: - sprop = properties[prop.name] - - # If we have a type: - if "type" in sprop: - prop.type = mtypes.Type(sprop["type"]) - else: - logger.warn( - "Missing type for property {}.{}.".format( - cls.canonical_name, prop.name - ) - ) - - # If we have a description: - if "desc" in sprop: - - # If desc is None, we do not warn user, because the entry is in - # settings, just empty: - if sprop["desc"] is not None: - prop.doc = sprop["desc"] - - else: - logger.warn( - "Missing description for property {}.{}.".format( - cls.canonical_name, prop.name - ) - ) - - # Patch signals - Everything should be in config since signals are not really - # exposed by boost::python. - signals: List[str] = csettings.pop("signals[]", []) - for signal in signals: - cls.constants.append( - mtypes.Constant(signal, mtypes.Type("pyqtSignal"), None) - ) - - # List of all items in csettings: - keys = {k: False for k in csettings} - - # Group method by name: - methods: Dict[str, List[mtypes.Method]] = defaultdict(list) - for m in cls.methods: - methods[m.name].append(m) - - for k, ms in methods.items(): - for i, m in enumerate(ms): - - # Find the name in settings: - if m.has_overloads(): - sname = "{}.{}".format(m.name, i + 1) - else: - sname = m.name - - missing_settings: Set[str] = set() - - # If the name is in the settings: - if sname in csettings: - keys[sname] = True - fsettings = self._parse_function_settings(csettings[sname]) - - # Force raises: - m.raises = fsettings.raises - - # Force static: - if fsettings.static is not None: - if m.is_static() != fsettings.static: - logger.warn( - "Forcing method {}.{} to be {}.".format( - cls.canonical_name, - sname, - "static" if fsettings.static else "non static", - ) - ) - m.static = fsettings.static - - if fsettings.abstract is not None: - m.abstract = fsettings.abstract - - # Check the args: - if fsettings.args is not None: - margs = m.args if m.is_static() else m.args[1:] - if len(fsettings.args) != len(margs): - logger.warn( - "Mismatch number of arguments for method {}.{}.".format( - cls.canonical_name, sname - ) - ) - - for sarg, marg in zip(fsettings.args, margs): - marg.doc = sarg.doc - marg.name = sarg.name - if not sarg.type.is_none(): - marg.type = sarg.type - - # Check the return type: - if fsettings.ret is not None: - - # Force the doc anyway: - m.ret.doc = fsettings.ret.doc - - # Update the type if specified: - if not fsettings.ret.type.is_none(): - m.ret.type = fsettings.ret.type - - # Force the doc: - m.doc = fsettings.doc - - # Force deprecated: - m.deprecated = fsettings.deprecated - - # Only warn for "normal" methods: - elif not m.name.startswith("__"): - missing_settings.add(sname) - - # Remove the deprecated methods: - noverloads = 0 - for m in ms: - overriden: bool = False - for bc in cls.all_bases: - for bm in bc.methods: - if bm.name == "__init__" or bm.name != m.name: - continue - if len(bm.args) == len(m.args) and all( - ba.type == ma.type - for ba, ma in zip(bm.args[1:], m.args[1:]) - ): - overriden = True - if m.is_deprecated() or overriden: - cls.methods.remove(m) - else: - noverloads += 1 - - for m in ms: - m.overloads = noverloads > 1 - - if noverloads > 0 and missing_settings: - for sname in missing_settings: - logger.warn( - "Missing settings for method {}.{}.".format( - cls.canonical_name, sname - ) - ) - - # Patch inner classes: - for ic in cls.inner_classes: - keys[ic.name] = True - self.patch_class(ic) - - # Mark the constant: - for cc in cls.constants: - keys[cc.name] = True - - # Print items missing in mobase - missings = [k for k, v in keys.items() if not v] - if missings: - logger.warn( - "The following members were found in settings but not in the actual" - " class {}: {}.".format(cls.canonical_name, ", ".join(missings)) # noqa - ) - - -def clean_class(cls: "mtypes.Class", settings: Settings): - """Clean the given class object. - - Args: - cls: The class object to clean. - settings: The settings. - """ - from .register import MOBASE_REGISTER - - # Remove duplicate methods (based on name and argument types): - methods: Dict[ - Tuple[str, Tuple[mtypes.Arg, ...]], List[mtypes.Method] - ] = OrderedDict() - methods_by_name = defaultdict(list) - for m in cls.methods: - k = (m.name, tuple(m.args[1:])) - if k not in methods: - methods[k] = [] - methods[k].append(m) - methods_by_name[m.name].append(m) - - clean_methods: List[mtypes.Method] = [] - for name, args in methods: - ms = methods[name, args] - method: mtypes.Method = ms[0] - if len(ms) > 1: - - # If we have more than two methods, there is a problem... - assert len(methods[name, args]) == 2 - assert ( - ms[0].ret.type.is_none() - or ms[1].ret.type.is_none() - or ms[0].ret.type.name == ms[1].ret.type.name - ) - - if ms[0].ret.type.is_none(): - # If both are None, we need to take the first one because the second - # one does not contains the name of the arguments, for whatever reason. - if ms[1].ret.type.is_none(): - method = ms[0] - else: - method = ms[1] - else: - method = ms[0] - - # If those were the only two, we need to remove the overload: - if len(methods_by_name[name]) == 2: - method.overloads = False - - # Filter methods from parent class: - if method.is_static(): - clean_methods.append(method) - else: - arg0_name = method.args[0].type.name - if arg0_name in MOBASE_REGISTER.cpp2py: - arg0_name = MOBASE_REGISTER.cpp2py[arg0_name].name - if arg0_name in [cls.name, "object"]: - clean_methods.append(method) - else: - logger.info( - "Removing {}({}) from {} (already in base {}).".format( - name, - ", ".join(a.type.typing(settings) for a in args), - cls.name, - method.args[0].type.typing(settings), - ) - ) - - # We need to filter-out __eq__(X, object) and __ne__(X, object) because these won't - # be filtered since the first arg is not of the right type: - for name in ("__eq__", "__ne__"): - fns = [m for m in clean_methods if m.name == name] - if len(fns) == 1 and fns[0].args[1].type.is_object(): - clean_methods.remove(fns[0]) - - cls.methods = clean_methods - - # Remove all non-uppercases enum names - This is a temporary fix to avoid breaking - # old plugins that uses old enum values: - if isinstance(cls, mtypes.Enum): - newc = [c for c in cls.constants if c.name.isupper()] - if newc: - cls.constants = newc - - # Clean inner classes: - for ic in cls.inner_classes: - clean_class(ic, settings) diff --git a/generator/writer.py b/generator/writer.py deleted file mode 100644 index b9b3a02..0000000 --- a/generator/writer.py +++ /dev/null @@ -1,216 +0,0 @@ -# -*- encoding: utf-8 -*- - -from typing import TextIO, List, Union, Tuple - -from . import logger -from .mtypes import Function, Class, Method, Property, Enum -from .utils import Settings - - -class Writer: - - _output: TextIO - _settings: Settings - - def __init__(self, output: TextIO, settings: Settings): - self._output = output - self._settings = settings - - def _print(self, *args, **kwargs): - kwargs["file"] = self._output - print(*args, **kwargs) - - def _print_doc(self, doc: str, indent: str): - """Print the given documentation at the given indentaiton level. - - Args: - doc: Documentation to print. - indent: Indentation. - """ - # Wrap in triple quotes: - doc = '"""\n' + doc.strip() + '\n"""' - self._print("\n".join((indent + line).rstrip() for line in doc.split("\n"))) - - def print_version(self, version: str): - self._print('__version__ = "{}"'.format(version)) - self._print() - - def print_imports(self, imports: List[Union[str, Tuple[str, List[str]]]]): - """ Print the given imports. """ - for imp in imports: - if isinstance(imp, str): - self._print("import {}".format(imp)) - else: - self._print("from {} import {}".format(imp[0], ", ".join(imp[1]))) - self._print() - - def print_function(self, fn: Function, indent: str = ""): - """ Print the given Function object at the given indentation level. """ - - if fn.has_overloads(): - self._print("{}@overload".format(indent)) - - srtype = "" - if not fn.ret.type.is_none(): - srtype = " -> " + fn.ret.type.typing(self._settings) - - fargs = fn.args - largs: List[str] = [] - if isinstance(fn, Method): - if fn.is_static(): - self._print("{}@staticmethod".format(indent)) - else: - if fn.is_abstract(): - self._print("{}@abc.abstractmethod".format(indent)) - - largs.insert(0, "self") - fargs = fargs[1:] - - for i, arg in enumerate(fargs): - tmp = "{}: {}".format(arg.name, arg.type.typing(self._settings)) - if arg.has_default_value(): - tmp += " = {}".format(arg.value) - largs.append(tmp) - sargs = ", ".join(largs) - - self._print("{}def {}({}){}:".format(indent, fn.name, sargs, srtype), end="") - - # Add the documentation, if any: - doc = "" - - if fn.doc: - doc = fn.doc.strip() + "\n" - - args = fn.args - if isinstance(fn, Method) and not fn.is_static(): - args = args[1:] - - if any(arg.doc for arg in args): - doc += "\nArgs:\n" - for arg in args: - adocl = arg.doc.strip().split("\n") - adoc = "\n".join([adocl[0]] + [" " + ldoc for ldoc in adocl[1:]]) - doc += " " + arg.name + ": " + adoc + "\n" - - if not fn.ret.type.is_none() and fn.ret.doc: - doc += "\nReturns:\n " + fn.ret.doc.strip() + "\n" - - if fn.raises: - doc += "\nRaises:\n" - for rai in fn.raises: - doc += ( - " " - + rai.type.typing(self._settings) - + ": " - + rai.doc.strip() - + "\n" - ) - - if doc: - self._print() - self._print_doc(doc, indent + " ") - self._print("{}...".format(indent + " ")) - else: - self._print(" ...") - - if not isinstance(fn, Method): - self._print() - - def print_property(self, cls: Class, prop: Property, indent: str): - """ Print the given Property object at the given indentation level. """ - - if prop.type.is_object() or prop.type.is_any(): - logger.warning( - "Property {}.{} does not have a specified type.".format( - cls.name, prop.name - ) - ) - - self._print("{}@property".format(indent)) - self._print( - "{}def {}(self) -> {}: ...".format( - indent, prop.name, prop.type.typing(self._settings) - ) - ) - if not prop.is_read_only(): - self._print("{}@{}.setter".format(indent, prop.name)) - self._print( - "{}def {}(self, arg0: {}): ...".format( - indent, prop.name, prop.type.typing(self._settings) - ) - ) - self._print() - - def print_class(self, cls: Class, indent: str = ""): - """ Print the given Class object at the given indentation level. """ - - bc = "" - if cls.bases or cls.is_abstract(): - bases = [str(bc) for bc in cls.bases] - if cls.is_abstract() and not any(bc.is_abstract() for bc in cls.bases): - bases.insert(0, "abc.ABC") - bc = "(" + ", ".join(bases) + ")" - - # Class declaration: - self._print("{}class {}{}:".format(indent, cls.name, bc), end="") - - if cls.doc: - self._print() - self._print_doc(cls.doc, indent + " ") - self._print() - - if not (cls.methods or cls.constants or cls.properties or cls.inner_classes): - if cls.doc: - self._print("{}...".format(indent + " ")) - else: - self._print(" ...") - return - - if not cls.doc: - self._print() - - # Inner classes: - for iclass in cls.inner_classes: - self.print_class(iclass, indent=indent + " ") - self._print() - - # Constants: - for constant in cls.constants: - comment = "" - if constant.doc: - comment = " # {}".format(constant.doc) - - typing = "" - if constant.type is not None: - typing = ": {}".format(constant.type.typing(self._settings)) - - # Note: We do not print the value, we use ... - self._print( - "{}{}{} = {}{}".format( - indent + " ", constant.name, typing, "...", comment, - ) - ) - - if cls.constants and (cls.properties or cls.methods): - self._print() - - # Properties: - for prop in cls.properties: - self.print_property(cls, prop, indent=indent + " ") - - # Methods: - # Put __init__ first, then special, then by name: - methods = sorted( - cls.methods, - key=lambda m: (m.name != "__init__", not m.is_special(), m.name), - ) - for method in methods: - self.print_function(method, indent=indent + " ") - - if cls.methods: - self._print() - - if not cls.outer_class: - if isinstance(cls, Enum): - self._print() - self._print() diff --git a/gh-pages/_images/check-setup-1.png b/gh-pages/_images/check-setup-1.png deleted file mode 100644 index 88053cd..0000000 Binary files a/gh-pages/_images/check-setup-1.png and /dev/null differ diff --git a/gh-pages/_images/check-setup-2.png b/gh-pages/_images/check-setup-2.png deleted file mode 100644 index 31def51..0000000 Binary files a/gh-pages/_images/check-setup-2.png and /dev/null differ diff --git a/gh-pages/_images/check-setup-3.png b/gh-pages/_images/check-setup-3.png deleted file mode 100644 index d56f9c8..0000000 Binary files a/gh-pages/_images/check-setup-3.png and /dev/null differ diff --git a/gh-pages/_images/error-window.png b/gh-pages/_images/error-window.png deleted file mode 100644 index 445e5da..0000000 Binary files a/gh-pages/_images/error-window.png and /dev/null differ diff --git a/gh-pages/_sources/api/mobase.BSAInvalidation.rst.txt b/gh-pages/_sources/api/mobase.BSAInvalidation.rst.txt deleted file mode 100644 index 55572c5..0000000 --- a/gh-pages/_sources/api/mobase.BSAInvalidation.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -BSAInvalidation -=============== - -.. currentmodule:: mobase - -.. autoclass:: BSAInvalidation - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~BSAInvalidation.activate - ~BSAInvalidation.deactivate - ~BSAInvalidation.isInvalidationBSA - - .. rubric:: Methods Documentation - - .. automethod:: activate - .. automethod:: deactivate - .. automethod:: isInvalidationBSA diff --git a/gh-pages/_sources/api/mobase.DataArchives.rst.txt b/gh-pages/_sources/api/mobase.DataArchives.rst.txt deleted file mode 100644 index 78b501b..0000000 --- a/gh-pages/_sources/api/mobase.DataArchives.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -DataArchives -============ - -.. currentmodule:: mobase - -.. autoclass:: DataArchives - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~DataArchives.addArchive - ~DataArchives.archives - ~DataArchives.removeArchive - ~DataArchives.vanillaArchives - - .. rubric:: Methods Documentation - - .. automethod:: addArchive - .. automethod:: archives - .. automethod:: removeArchive - .. automethod:: vanillaArchives diff --git a/gh-pages/_sources/api/mobase.ExecutableForcedLoadSetting.rst.txt b/gh-pages/_sources/api/mobase.ExecutableForcedLoadSetting.rst.txt deleted file mode 100644 index 2e5226c..0000000 --- a/gh-pages/_sources/api/mobase.ExecutableForcedLoadSetting.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -ExecutableForcedLoadSetting -=========================== - -.. currentmodule:: mobase - -.. autoclass:: ExecutableForcedLoadSetting - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ExecutableForcedLoadSetting.enabled - ~ExecutableForcedLoadSetting.forced - ~ExecutableForcedLoadSetting.library - ~ExecutableForcedLoadSetting.process - ~ExecutableForcedLoadSetting.withEnabled - ~ExecutableForcedLoadSetting.withForced - - .. rubric:: Methods Documentation - - .. automethod:: enabled - .. automethod:: forced - .. automethod:: library - .. automethod:: process - .. automethod:: withEnabled - .. automethod:: withForced diff --git a/gh-pages/_sources/api/mobase.ExecutableInfo.rst.txt b/gh-pages/_sources/api/mobase.ExecutableInfo.rst.txt deleted file mode 100644 index 2588e88..0000000 --- a/gh-pages/_sources/api/mobase.ExecutableInfo.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -ExecutableInfo -============== - -.. currentmodule:: mobase - -.. autoclass:: ExecutableInfo - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ExecutableInfo.arguments - ~ExecutableInfo.asCustom - ~ExecutableInfo.binary - ~ExecutableInfo.isCustom - ~ExecutableInfo.isValid - ~ExecutableInfo.steamAppID - ~ExecutableInfo.title - ~ExecutableInfo.withArgument - ~ExecutableInfo.withSteamAppId - ~ExecutableInfo.withWorkingDirectory - ~ExecutableInfo.workingDirectory - - .. rubric:: Methods Documentation - - .. automethod:: arguments - .. automethod:: asCustom - .. automethod:: binary - .. automethod:: isCustom - .. automethod:: isValid - .. automethod:: steamAppID - .. automethod:: title - .. automethod:: withArgument - .. automethod:: withSteamAppId - .. automethod:: withWorkingDirectory - .. automethod:: workingDirectory diff --git a/gh-pages/_sources/api/mobase.FileInfo.rst.txt b/gh-pages/_sources/api/mobase.FileInfo.rst.txt deleted file mode 100644 index 4fdd871..0000000 --- a/gh-pages/_sources/api/mobase.FileInfo.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -FileInfo -======== - -.. currentmodule:: mobase - -.. autoclass:: FileInfo - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~FileInfo.archive - ~FileInfo.filePath - ~FileInfo.origins - - .. rubric:: Attributes Documentation - - .. autoattribute:: archive - .. autoattribute:: filePath - .. autoattribute:: origins diff --git a/gh-pages/_sources/api/mobase.FileTreeEntry.rst.txt b/gh-pages/_sources/api/mobase.FileTreeEntry.rst.txt deleted file mode 100644 index 97be645..0000000 --- a/gh-pages/_sources/api/mobase.FileTreeEntry.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -FileTreeEntry -============= - -.. currentmodule:: mobase - -.. autoclass:: FileTreeEntry - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~FileTreeEntry.DIRECTORY - ~FileTreeEntry.FILE - ~FileTreeEntry.FILE_OR_DIRECTORY - - .. rubric:: Methods Summary - - .. autosummary:: - - ~FileTreeEntry.detach - ~FileTreeEntry.fileType - ~FileTreeEntry.hasSuffix - ~FileTreeEntry.isDir - ~FileTreeEntry.isFile - ~FileTreeEntry.moveTo - ~FileTreeEntry.name - ~FileTreeEntry.parent - ~FileTreeEntry.path - ~FileTreeEntry.pathFrom - ~FileTreeEntry.suffix - - .. rubric:: Attributes Documentation - - .. autoattribute:: DIRECTORY - .. autoattribute:: FILE - .. autoattribute:: FILE_OR_DIRECTORY - - .. rubric:: Methods Documentation - - .. automethod:: detach - .. automethod:: fileType - .. automethod:: hasSuffix - .. automethod:: isDir - .. automethod:: isFile - .. automethod:: moveTo - .. automethod:: name - .. automethod:: parent - .. automethod:: path - .. automethod:: pathFrom - .. automethod:: suffix diff --git a/gh-pages/_sources/api/mobase.GamePlugins.rst.txt b/gh-pages/_sources/api/mobase.GamePlugins.rst.txt deleted file mode 100644 index be8cb88..0000000 --- a/gh-pages/_sources/api/mobase.GamePlugins.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -GamePlugins -=========== - -.. currentmodule:: mobase - -.. autoclass:: GamePlugins - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~GamePlugins.getLoadOrder - ~GamePlugins.lightPluginsAreSupported - ~GamePlugins.readPluginLists - ~GamePlugins.writePluginLists - - .. rubric:: Methods Documentation - - .. automethod:: getLoadOrder - .. automethod:: lightPluginsAreSupported - .. automethod:: readPluginLists - .. automethod:: writePluginLists diff --git a/gh-pages/_sources/api/mobase.GuessQuality.rst.txt b/gh-pages/_sources/api/mobase.GuessQuality.rst.txt deleted file mode 100644 index f560c8c..0000000 --- a/gh-pages/_sources/api/mobase.GuessQuality.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -GuessQuality -============ - -.. currentmodule:: mobase - -.. autoclass:: GuessQuality - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~GuessQuality.FALLBACK - ~GuessQuality.GOOD - ~GuessQuality.INVALID - ~GuessQuality.META - ~GuessQuality.PRESET - ~GuessQuality.USER - - .. rubric:: Attributes Documentation - - .. autoattribute:: FALLBACK - .. autoattribute:: GOOD - .. autoattribute:: INVALID - .. autoattribute:: META - .. autoattribute:: PRESET - .. autoattribute:: USER diff --git a/gh-pages/_sources/api/mobase.GuessedString.rst.txt b/gh-pages/_sources/api/mobase.GuessedString.rst.txt deleted file mode 100644 index 6da307d..0000000 --- a/gh-pages/_sources/api/mobase.GuessedString.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -GuessedString -============= - -.. currentmodule:: mobase - -.. autoclass:: GuessedString - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~GuessedString.reset - ~GuessedString.setFilter - ~GuessedString.update - ~GuessedString.variants - - .. rubric:: Methods Documentation - - .. automethod:: reset - .. automethod:: setFilter - .. automethod:: update - .. automethod:: variants diff --git a/gh-pages/_sources/api/mobase.IDownloadManager.rst.txt b/gh-pages/_sources/api/mobase.IDownloadManager.rst.txt deleted file mode 100644 index 6c791d5..0000000 --- a/gh-pages/_sources/api/mobase.IDownloadManager.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -IDownloadManager -================ - -.. currentmodule:: mobase - -.. autoclass:: IDownloadManager - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~IDownloadManager.downloadComplete - ~IDownloadManager.downloadFailed - ~IDownloadManager.downloadPaused - ~IDownloadManager.downloadRemoved - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IDownloadManager.downloadPath - ~IDownloadManager.startDownloadNexusFile - ~IDownloadManager.startDownloadURLs - - .. rubric:: Attributes Documentation - - .. autoattribute:: downloadComplete - .. autoattribute:: downloadFailed - .. autoattribute:: downloadPaused - .. autoattribute:: downloadRemoved - - .. rubric:: Methods Documentation - - .. automethod:: downloadPath - .. automethod:: startDownloadNexusFile - .. automethod:: startDownloadURLs diff --git a/gh-pages/_sources/api/mobase.IFileTree.rst.txt b/gh-pages/_sources/api/mobase.IFileTree.rst.txt deleted file mode 100644 index 92f7c9a..0000000 --- a/gh-pages/_sources/api/mobase.IFileTree.rst.txt +++ /dev/null @@ -1,65 +0,0 @@ -IFileTree -========= - -.. currentmodule:: mobase - -.. autoclass:: IFileTree - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~IFileTree.CONTINUE - ~IFileTree.FAIL_IF_EXISTS - ~IFileTree.MERGE - ~IFileTree.REPLACE - ~IFileTree.SKIP - ~IFileTree.STOP - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IFileTree.addDirectory - ~IFileTree.addFile - ~IFileTree.clear - ~IFileTree.copy - ~IFileTree.createOrphanTree - ~IFileTree.exists - ~IFileTree.find - ~IFileTree.insert - ~IFileTree.merge - ~IFileTree.move - ~IFileTree.pathTo - ~IFileTree.remove - ~IFileTree.removeAll - ~IFileTree.removeIf - ~IFileTree.walk - - .. rubric:: Attributes Documentation - - .. autoattribute:: CONTINUE - .. autoattribute:: FAIL_IF_EXISTS - .. autoattribute:: MERGE - .. autoattribute:: REPLACE - .. autoattribute:: SKIP - .. autoattribute:: STOP - - .. rubric:: Methods Documentation - - .. automethod:: addDirectory - .. automethod:: addFile - .. automethod:: clear - .. automethod:: copy - .. automethod:: createOrphanTree - .. automethod:: exists - .. automethod:: find - .. automethod:: insert - .. automethod:: merge - .. automethod:: move - .. automethod:: pathTo - .. automethod:: remove - .. automethod:: removeAll - .. automethod:: removeIf - .. automethod:: walk diff --git a/gh-pages/_sources/api/mobase.IInstallationManager.rst.txt b/gh-pages/_sources/api/mobase.IInstallationManager.rst.txt deleted file mode 100644 index 0b1b8a9..0000000 --- a/gh-pages/_sources/api/mobase.IInstallationManager.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -IInstallationManager -==================== - -.. currentmodule:: mobase - -.. autoclass:: IInstallationManager - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IInstallationManager.createFile - ~IInstallationManager.extractFile - ~IInstallationManager.extractFiles - ~IInstallationManager.getSupportedExtensions - ~IInstallationManager.installArchive - ~IInstallationManager.setURL - - .. rubric:: Methods Documentation - - .. automethod:: createFile - .. automethod:: extractFile - .. automethod:: extractFiles - .. automethod:: getSupportedExtensions - .. automethod:: installArchive - .. automethod:: setURL diff --git a/gh-pages/_sources/api/mobase.IModInterface.rst.txt b/gh-pages/_sources/api/mobase.IModInterface.rst.txt deleted file mode 100644 index b29fb8b..0000000 --- a/gh-pages/_sources/api/mobase.IModInterface.rst.txt +++ /dev/null @@ -1,41 +0,0 @@ -IModInterface -============= - -.. currentmodule:: mobase - -.. autoclass:: IModInterface - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IModInterface.absolutePath - ~IModInterface.addCategory - ~IModInterface.addNexusCategory - ~IModInterface.categories - ~IModInterface.name - ~IModInterface.remove - ~IModInterface.removeCategory - ~IModInterface.setGameName - ~IModInterface.setIsEndorsed - ~IModInterface.setName - ~IModInterface.setNewestVersion - ~IModInterface.setNexusID - ~IModInterface.setVersion - - .. rubric:: Methods Documentation - - .. automethod:: absolutePath - .. automethod:: addCategory - .. automethod:: addNexusCategory - .. automethod:: categories - .. automethod:: name - .. automethod:: remove - .. automethod:: removeCategory - .. automethod:: setGameName - .. automethod:: setIsEndorsed - .. automethod:: setName - .. automethod:: setNewestVersion - .. automethod:: setNexusID - .. automethod:: setVersion diff --git a/gh-pages/_sources/api/mobase.IModList.rst.txt b/gh-pages/_sources/api/mobase.IModList.rst.txt deleted file mode 100644 index 8e659ff..0000000 --- a/gh-pages/_sources/api/mobase.IModList.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -IModList -======== - -.. currentmodule:: mobase - -.. autoclass:: IModList - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IModList.allMods - ~IModList.displayName - ~IModList.onModMoved - ~IModList.onModStateChanged - ~IModList.priority - ~IModList.setActive - ~IModList.setPriority - ~IModList.state - - .. rubric:: Methods Documentation - - .. automethod:: allMods - .. automethod:: displayName - .. automethod:: onModMoved - .. automethod:: onModStateChanged - .. automethod:: priority - .. automethod:: setActive - .. automethod:: setPriority - .. automethod:: state diff --git a/gh-pages/_sources/api/mobase.IModRepositoryBridge.rst.txt b/gh-pages/_sources/api/mobase.IModRepositoryBridge.rst.txt deleted file mode 100644 index 2f5240f..0000000 --- a/gh-pages/_sources/api/mobase.IModRepositoryBridge.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -IModRepositoryBridge -==================== - -.. currentmodule:: mobase - -.. autoclass:: IModRepositoryBridge - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~IModRepositoryBridge.descriptionAvailable - ~IModRepositoryBridge.downloadURLsAvailable - ~IModRepositoryBridge.endorsementToggled - ~IModRepositoryBridge.endorsementsAvailable - ~IModRepositoryBridge.fileInfoAvailable - ~IModRepositoryBridge.filesAvailable - ~IModRepositoryBridge.requestFailed - ~IModRepositoryBridge.trackedModsAvailable - ~IModRepositoryBridge.trackingToggled - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IModRepositoryBridge.requestDescription - ~IModRepositoryBridge.requestDownloadURL - ~IModRepositoryBridge.requestFileInfo - ~IModRepositoryBridge.requestFiles - ~IModRepositoryBridge.requestToggleEndorsement - - .. rubric:: Attributes Documentation - - .. autoattribute:: descriptionAvailable - .. autoattribute:: downloadURLsAvailable - .. autoattribute:: endorsementToggled - .. autoattribute:: endorsementsAvailable - .. autoattribute:: fileInfoAvailable - .. autoattribute:: filesAvailable - .. autoattribute:: requestFailed - .. autoattribute:: trackedModsAvailable - .. autoattribute:: trackingToggled - - .. rubric:: Methods Documentation - - .. automethod:: requestDescription - .. automethod:: requestDownloadURL - .. automethod:: requestFileInfo - .. automethod:: requestFiles - .. automethod:: requestToggleEndorsement diff --git a/gh-pages/_sources/api/mobase.IOrganizer.rst.txt b/gh-pages/_sources/api/mobase.IOrganizer.rst.txt deleted file mode 100644 index 0aee3dd..0000000 --- a/gh-pages/_sources/api/mobase.IOrganizer.rst.txt +++ /dev/null @@ -1,93 +0,0 @@ -IOrganizer -========== - -.. currentmodule:: mobase - -.. autoclass:: IOrganizer - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IOrganizer.appVersion - ~IOrganizer.basePath - ~IOrganizer.createMod - ~IOrganizer.createNexusBridge - ~IOrganizer.downloadManager - ~IOrganizer.downloadsPath - ~IOrganizer.findFileInfos - ~IOrganizer.findFiles - ~IOrganizer.getFileOrigins - ~IOrganizer.getGame - ~IOrganizer.getMod - ~IOrganizer.installMod - ~IOrganizer.listDirectories - ~IOrganizer.managedGame - ~IOrganizer.modDataChanged - ~IOrganizer.modList - ~IOrganizer.modsPath - ~IOrganizer.modsSortedByProfilePriority - ~IOrganizer.onAboutToRun - ~IOrganizer.onFinishedRun - ~IOrganizer.onModInstalled - ~IOrganizer.onPluginSettingChanged - ~IOrganizer.onProfileChanged - ~IOrganizer.onUserInterfaceInitialized - ~IOrganizer.overwritePath - ~IOrganizer.persistent - ~IOrganizer.pluginDataPath - ~IOrganizer.pluginList - ~IOrganizer.pluginSetting - ~IOrganizer.profile - ~IOrganizer.profileName - ~IOrganizer.profilePath - ~IOrganizer.refreshModList - ~IOrganizer.removeMod - ~IOrganizer.resolvePath - ~IOrganizer.setPersistent - ~IOrganizer.setPluginSetting - ~IOrganizer.startApplication - ~IOrganizer.waitForApplication - - .. rubric:: Methods Documentation - - .. automethod:: appVersion - .. automethod:: basePath - .. automethod:: createMod - .. automethod:: createNexusBridge - .. automethod:: downloadManager - .. automethod:: downloadsPath - .. automethod:: findFileInfos - .. automethod:: findFiles - .. automethod:: getFileOrigins - .. automethod:: getGame - .. automethod:: getMod - .. automethod:: installMod - .. automethod:: listDirectories - .. automethod:: managedGame - .. automethod:: modDataChanged - .. automethod:: modList - .. automethod:: modsPath - .. automethod:: modsSortedByProfilePriority - .. automethod:: onAboutToRun - .. automethod:: onFinishedRun - .. automethod:: onModInstalled - .. automethod:: onPluginSettingChanged - .. automethod:: onProfileChanged - .. automethod:: onUserInterfaceInitialized - .. automethod:: overwritePath - .. automethod:: persistent - .. automethod:: pluginDataPath - .. automethod:: pluginList - .. automethod:: pluginSetting - .. automethod:: profile - .. automethod:: profileName - .. automethod:: profilePath - .. automethod:: refreshModList - .. automethod:: removeMod - .. automethod:: resolvePath - .. automethod:: setPersistent - .. automethod:: setPluginSetting - .. automethod:: startApplication - .. automethod:: waitForApplication diff --git a/gh-pages/_sources/api/mobase.IPlugin.rst.txt b/gh-pages/_sources/api/mobase.IPlugin.rst.txt deleted file mode 100644 index 5e33568..0000000 --- a/gh-pages/_sources/api/mobase.IPlugin.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -IPlugin -======= - -.. currentmodule:: mobase - -.. autoclass:: IPlugin - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPlugin.author - ~IPlugin.description - ~IPlugin.init - ~IPlugin.isActive - ~IPlugin.name - ~IPlugin.settings - ~IPlugin.version - - .. rubric:: Methods Documentation - - .. automethod:: author - .. automethod:: description - .. automethod:: init - .. automethod:: isActive - .. automethod:: name - .. automethod:: settings - .. automethod:: version diff --git a/gh-pages/_sources/api/mobase.IPluginDiagnose.rst.txt b/gh-pages/_sources/api/mobase.IPluginDiagnose.rst.txt deleted file mode 100644 index b8cf060..0000000 --- a/gh-pages/_sources/api/mobase.IPluginDiagnose.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -IPluginDiagnose -=============== - -.. currentmodule:: mobase - -.. autoclass:: IPluginDiagnose - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginDiagnose.activeProblems - ~IPluginDiagnose.fullDescription - ~IPluginDiagnose.hasGuidedFix - ~IPluginDiagnose.shortDescription - ~IPluginDiagnose.startGuidedFix - - .. rubric:: Methods Documentation - - .. automethod:: activeProblems - .. automethod:: fullDescription - .. automethod:: hasGuidedFix - .. automethod:: shortDescription - .. automethod:: startGuidedFix diff --git a/gh-pages/_sources/api/mobase.IPluginFileMapper.rst.txt b/gh-pages/_sources/api/mobase.IPluginFileMapper.rst.txt deleted file mode 100644 index 2915e86..0000000 --- a/gh-pages/_sources/api/mobase.IPluginFileMapper.rst.txt +++ /dev/null @@ -1,17 +0,0 @@ -IPluginFileMapper -================= - -.. currentmodule:: mobase - -.. autoclass:: IPluginFileMapper - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginFileMapper.mappings - - .. rubric:: Methods Documentation - - .. automethod:: mappings diff --git a/gh-pages/_sources/api/mobase.IPluginGame.rst.txt b/gh-pages/_sources/api/mobase.IPluginGame.rst.txt deleted file mode 100644 index a8f6ae0..0000000 --- a/gh-pages/_sources/api/mobase.IPluginGame.rst.txt +++ /dev/null @@ -1,83 +0,0 @@ -IPluginGame -=========== - -.. currentmodule:: mobase - -.. autoclass:: IPluginGame - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginGame.CCPlugins - ~IPluginGame.DLCPlugins - ~IPluginGame.binaryName - ~IPluginGame.dataDirectory - ~IPluginGame.documentsDirectory - ~IPluginGame.executableForcedLoads - ~IPluginGame.executables - ~IPluginGame.feature - ~IPluginGame.featureList - ~IPluginGame.gameDirectory - ~IPluginGame.gameIcon - ~IPluginGame.gameName - ~IPluginGame.gameNexusName - ~IPluginGame.gameShortName - ~IPluginGame.gameVariants - ~IPluginGame.gameVersion - ~IPluginGame.getLauncherName - ~IPluginGame.iniFiles - ~IPluginGame.initializeProfile - ~IPluginGame.isInstalled - ~IPluginGame.loadOrderMechanism - ~IPluginGame.looksValid - ~IPluginGame.nexusGameID - ~IPluginGame.nexusModOrganizerID - ~IPluginGame.primaryPlugins - ~IPluginGame.primarySources - ~IPluginGame.savegameExtension - ~IPluginGame.savegameSEExtension - ~IPluginGame.savesDirectory - ~IPluginGame.setGamePath - ~IPluginGame.setGameVariant - ~IPluginGame.sortMechanism - ~IPluginGame.steamAPPId - ~IPluginGame.validShortNames - - .. rubric:: Methods Documentation - - .. automethod:: CCPlugins - .. automethod:: DLCPlugins - .. automethod:: binaryName - .. automethod:: dataDirectory - .. automethod:: documentsDirectory - .. automethod:: executableForcedLoads - .. automethod:: executables - .. automethod:: feature - .. automethod:: featureList - .. automethod:: gameDirectory - .. automethod:: gameIcon - .. automethod:: gameName - .. automethod:: gameNexusName - .. automethod:: gameShortName - .. automethod:: gameVariants - .. automethod:: gameVersion - .. automethod:: getLauncherName - .. automethod:: iniFiles - .. automethod:: initializeProfile - .. automethod:: isInstalled - .. automethod:: loadOrderMechanism - .. automethod:: looksValid - .. automethod:: nexusGameID - .. automethod:: nexusModOrganizerID - .. automethod:: primaryPlugins - .. automethod:: primarySources - .. automethod:: savegameExtension - .. automethod:: savegameSEExtension - .. automethod:: savesDirectory - .. automethod:: setGamePath - .. automethod:: setGameVariant - .. automethod:: sortMechanism - .. automethod:: steamAPPId - .. automethod:: validShortNames diff --git a/gh-pages/_sources/api/mobase.IPluginInstaller.rst.txt b/gh-pages/_sources/api/mobase.IPluginInstaller.rst.txt deleted file mode 100644 index b6f6384..0000000 --- a/gh-pages/_sources/api/mobase.IPluginInstaller.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -IPluginInstaller -================ - -.. currentmodule:: mobase - -.. autoclass:: IPluginInstaller - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginInstaller.isArchiveSupported - ~IPluginInstaller.isManualInstaller - ~IPluginInstaller.priority - ~IPluginInstaller.setInstallationManager - ~IPluginInstaller.setParentWidget - - .. rubric:: Methods Documentation - - .. automethod:: isArchiveSupported - .. automethod:: isManualInstaller - .. automethod:: priority - .. automethod:: setInstallationManager - .. automethod:: setParentWidget diff --git a/gh-pages/_sources/api/mobase.IPluginInstallerCustom.rst.txt b/gh-pages/_sources/api/mobase.IPluginInstallerCustom.rst.txt deleted file mode 100644 index ecffac2..0000000 --- a/gh-pages/_sources/api/mobase.IPluginInstallerCustom.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -IPluginInstallerCustom -====================== - -.. currentmodule:: mobase - -.. autoclass:: IPluginInstallerCustom - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginInstallerCustom.install - ~IPluginInstallerCustom.isArchiveSupported - ~IPluginInstallerCustom.supportedExtensions - - .. rubric:: Methods Documentation - - .. automethod:: install - .. automethod:: isArchiveSupported - .. automethod:: supportedExtensions diff --git a/gh-pages/_sources/api/mobase.IPluginInstallerSimple.rst.txt b/gh-pages/_sources/api/mobase.IPluginInstallerSimple.rst.txt deleted file mode 100644 index 328732e..0000000 --- a/gh-pages/_sources/api/mobase.IPluginInstallerSimple.rst.txt +++ /dev/null @@ -1,17 +0,0 @@ -IPluginInstallerSimple -====================== - -.. currentmodule:: mobase - -.. autoclass:: IPluginInstallerSimple - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginInstallerSimple.install - - .. rubric:: Methods Documentation - - .. automethod:: install diff --git a/gh-pages/_sources/api/mobase.IPluginList.rst.txt b/gh-pages/_sources/api/mobase.IPluginList.rst.txt deleted file mode 100644 index 537af5f..0000000 --- a/gh-pages/_sources/api/mobase.IPluginList.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -IPluginList -=========== - -.. currentmodule:: mobase - -.. autoclass:: IPluginList - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginList.isMaster - ~IPluginList.loadOrder - ~IPluginList.masters - ~IPluginList.onPluginMoved - ~IPluginList.onRefreshed - ~IPluginList.origin - ~IPluginList.pluginNames - ~IPluginList.priority - ~IPluginList.setLoadOrder - ~IPluginList.setState - ~IPluginList.state - - .. rubric:: Methods Documentation - - .. automethod:: isMaster - .. automethod:: loadOrder - .. automethod:: masters - .. automethod:: onPluginMoved - .. automethod:: onRefreshed - .. automethod:: origin - .. automethod:: pluginNames - .. automethod:: priority - .. automethod:: setLoadOrder - .. automethod:: setState - .. automethod:: state diff --git a/gh-pages/_sources/api/mobase.IPluginModPage.rst.txt b/gh-pages/_sources/api/mobase.IPluginModPage.rst.txt deleted file mode 100644 index 4ca98f7..0000000 --- a/gh-pages/_sources/api/mobase.IPluginModPage.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -IPluginModPage -============== - -.. currentmodule:: mobase - -.. autoclass:: IPluginModPage - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginModPage.displayName - ~IPluginModPage.handlesDownload - ~IPluginModPage.icon - ~IPluginModPage.pageURL - ~IPluginModPage.setParentWidget - ~IPluginModPage.useIntegratedBrowser - - .. rubric:: Methods Documentation - - .. automethod:: displayName - .. automethod:: handlesDownload - .. automethod:: icon - .. automethod:: pageURL - .. automethod:: setParentWidget - .. automethod:: useIntegratedBrowser diff --git a/gh-pages/_sources/api/mobase.IPluginPreview.rst.txt b/gh-pages/_sources/api/mobase.IPluginPreview.rst.txt deleted file mode 100644 index 7b125c8..0000000 --- a/gh-pages/_sources/api/mobase.IPluginPreview.rst.txt +++ /dev/null @@ -1,19 +0,0 @@ -IPluginPreview -============== - -.. currentmodule:: mobase - -.. autoclass:: IPluginPreview - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginPreview.genFilePreview - ~IPluginPreview.supportedExtensions - - .. rubric:: Methods Documentation - - .. automethod:: genFilePreview - .. automethod:: supportedExtensions diff --git a/gh-pages/_sources/api/mobase.IPluginTool.rst.txt b/gh-pages/_sources/api/mobase.IPluginTool.rst.txt deleted file mode 100644 index 56265fe..0000000 --- a/gh-pages/_sources/api/mobase.IPluginTool.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -IPluginTool -=========== - -.. currentmodule:: mobase - -.. autoclass:: IPluginTool - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginTool.display - ~IPluginTool.displayName - ~IPluginTool.icon - ~IPluginTool.setParentWidget - ~IPluginTool.tooltip - - .. rubric:: Methods Documentation - - .. automethod:: display - .. automethod:: displayName - .. automethod:: icon - .. automethod:: setParentWidget - .. automethod:: tooltip diff --git a/gh-pages/_sources/api/mobase.IProfile.rst.txt b/gh-pages/_sources/api/mobase.IProfile.rst.txt deleted file mode 100644 index 16ab1eb..0000000 --- a/gh-pages/_sources/api/mobase.IProfile.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -IProfile -======== - -.. currentmodule:: mobase - -.. autoclass:: IProfile - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IProfile.absolutePath - ~IProfile.invalidationActive - ~IProfile.localSavesEnabled - ~IProfile.localSettingsEnabled - ~IProfile.name - - .. rubric:: Methods Documentation - - .. automethod:: absolutePath - .. automethod:: invalidationActive - .. automethod:: localSavesEnabled - .. automethod:: localSettingsEnabled - .. automethod:: name diff --git a/gh-pages/_sources/api/mobase.ISaveGame.rst.txt b/gh-pages/_sources/api/mobase.ISaveGame.rst.txt deleted file mode 100644 index 8012cff..0000000 --- a/gh-pages/_sources/api/mobase.ISaveGame.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -ISaveGame -========= - -.. currentmodule:: mobase - -.. autoclass:: ISaveGame - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ISaveGame.allFiles - ~ISaveGame.getCreationTime - ~ISaveGame.getFilename - ~ISaveGame.getSaveGroupIdentifier - ~ISaveGame.hasScriptExtenderFile - - .. rubric:: Methods Documentation - - .. automethod:: allFiles - .. automethod:: getCreationTime - .. automethod:: getFilename - .. automethod:: getSaveGroupIdentifier - .. automethod:: hasScriptExtenderFile diff --git a/gh-pages/_sources/api/mobase.ISaveGameInfoWidget.rst.txt b/gh-pages/_sources/api/mobase.ISaveGameInfoWidget.rst.txt deleted file mode 100644 index 6b32d9f..0000000 --- a/gh-pages/_sources/api/mobase.ISaveGameInfoWidget.rst.txt +++ /dev/null @@ -1,17 +0,0 @@ -ISaveGameInfoWidget -=================== - -.. currentmodule:: mobase - -.. autoclass:: ISaveGameInfoWidget - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ISaveGameInfoWidget.setSave - - .. rubric:: Methods Documentation - - .. automethod:: setSave diff --git a/gh-pages/_sources/api/mobase.InstallResult.rst.txt b/gh-pages/_sources/api/mobase.InstallResult.rst.txt deleted file mode 100644 index a0eb701..0000000 --- a/gh-pages/_sources/api/mobase.InstallResult.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -InstallResult -============= - -.. currentmodule:: mobase - -.. autoclass:: InstallResult - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~InstallResult.CANCELED - ~InstallResult.FAILED - ~InstallResult.MANUAL_REQUESTED - ~InstallResult.NOT_ATTEMPTED - ~InstallResult.SUCCESS - - .. rubric:: Attributes Documentation - - .. autoattribute:: CANCELED - .. autoattribute:: FAILED - .. autoattribute:: MANUAL_REQUESTED - .. autoattribute:: NOT_ATTEMPTED - .. autoattribute:: SUCCESS diff --git a/gh-pages/_sources/api/mobase.InterfaceNotImplemented.rst.txt b/gh-pages/_sources/api/mobase.InterfaceNotImplemented.rst.txt deleted file mode 100644 index 5d26e13..0000000 --- a/gh-pages/_sources/api/mobase.InterfaceNotImplemented.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -InterfaceNotImplemented -======================= - -.. currentmodule:: mobase - -.. autoclass:: InterfaceNotImplemented - :show-inheritance: diff --git a/gh-pages/_sources/api/mobase.LoadOrderMechanism.rst.txt b/gh-pages/_sources/api/mobase.LoadOrderMechanism.rst.txt deleted file mode 100644 index dafd847..0000000 --- a/gh-pages/_sources/api/mobase.LoadOrderMechanism.rst.txt +++ /dev/null @@ -1,19 +0,0 @@ -LoadOrderMechanism -================== - -.. currentmodule:: mobase - -.. autoclass:: LoadOrderMechanism - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~LoadOrderMechanism.FILE_TIME - ~LoadOrderMechanism.PLUGINS_TXT - - .. rubric:: Attributes Documentation - - .. autoattribute:: FILE_TIME - .. autoattribute:: PLUGINS_TXT diff --git a/gh-pages/_sources/api/mobase.LocalSavegames.rst.txt b/gh-pages/_sources/api/mobase.LocalSavegames.rst.txt deleted file mode 100644 index 1d8b445..0000000 --- a/gh-pages/_sources/api/mobase.LocalSavegames.rst.txt +++ /dev/null @@ -1,19 +0,0 @@ -LocalSavegames -============== - -.. currentmodule:: mobase - -.. autoclass:: LocalSavegames - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~LocalSavegames.mappings - ~LocalSavegames.prepareProfile - - .. rubric:: Methods Documentation - - .. automethod:: mappings - .. automethod:: prepareProfile diff --git a/gh-pages/_sources/api/mobase.Mapping.rst.txt b/gh-pages/_sources/api/mobase.Mapping.rst.txt deleted file mode 100644 index 0c628ee..0000000 --- a/gh-pages/_sources/api/mobase.Mapping.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -Mapping -======= - -.. currentmodule:: mobase - -.. autoclass:: Mapping - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~Mapping.createTarget - ~Mapping.destination - ~Mapping.isDirectory - ~Mapping.source - - .. rubric:: Attributes Documentation - - .. autoattribute:: createTarget - .. autoattribute:: destination - .. autoattribute:: isDirectory - .. autoattribute:: source diff --git a/gh-pages/_sources/api/mobase.ModDataChecker.rst.txt b/gh-pages/_sources/api/mobase.ModDataChecker.rst.txt deleted file mode 100644 index 25b7c55..0000000 --- a/gh-pages/_sources/api/mobase.ModDataChecker.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -ModDataChecker -============== - -.. currentmodule:: mobase - -.. autoclass:: ModDataChecker - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~ModDataChecker.FIXABLE - ~ModDataChecker.INVALID - ~ModDataChecker.VALID - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ModDataChecker.dataLooksValid - ~ModDataChecker.fix - - .. rubric:: Attributes Documentation - - .. autoattribute:: FIXABLE - .. autoattribute:: INVALID - .. autoattribute:: VALID - - .. rubric:: Methods Documentation - - .. automethod:: dataLooksValid - .. automethod:: fix diff --git a/gh-pages/_sources/api/mobase.ModDataContent.rst.txt b/gh-pages/_sources/api/mobase.ModDataContent.rst.txt deleted file mode 100644 index 3860c13..0000000 --- a/gh-pages/_sources/api/mobase.ModDataContent.rst.txt +++ /dev/null @@ -1,19 +0,0 @@ -ModDataContent -============== - -.. currentmodule:: mobase - -.. autoclass:: ModDataContent - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ModDataContent.getAllContents - ~ModDataContent.getContentsFor - - .. rubric:: Methods Documentation - - .. automethod:: getAllContents - .. automethod:: getContentsFor diff --git a/gh-pages/_sources/api/mobase.ModRepositoryFileInfo.rst.txt b/gh-pages/_sources/api/mobase.ModRepositoryFileInfo.rst.txt deleted file mode 100644 index 20710c0..0000000 --- a/gh-pages/_sources/api/mobase.ModRepositoryFileInfo.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ModRepositoryFileInfo -===================== - -.. currentmodule:: mobase - -.. autoclass:: ModRepositoryFileInfo - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~ModRepositoryFileInfo.categoryID - ~ModRepositoryFileInfo.description - ~ModRepositoryFileInfo.fileCategory - ~ModRepositoryFileInfo.fileID - ~ModRepositoryFileInfo.fileName - ~ModRepositoryFileInfo.fileSize - ~ModRepositoryFileInfo.fileTime - ~ModRepositoryFileInfo.gameName - ~ModRepositoryFileInfo.modID - ~ModRepositoryFileInfo.modName - ~ModRepositoryFileInfo.name - ~ModRepositoryFileInfo.newestVersion - ~ModRepositoryFileInfo.repository - ~ModRepositoryFileInfo.uri - ~ModRepositoryFileInfo.userData - ~ModRepositoryFileInfo.version - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ModRepositoryFileInfo.createFromJson - - .. rubric:: Attributes Documentation - - .. autoattribute:: categoryID - .. autoattribute:: description - .. autoattribute:: fileCategory - .. autoattribute:: fileID - .. autoattribute:: fileName - .. autoattribute:: fileSize - .. autoattribute:: fileTime - .. autoattribute:: gameName - .. autoattribute:: modID - .. autoattribute:: modName - .. autoattribute:: name - .. autoattribute:: newestVersion - .. autoattribute:: repository - .. autoattribute:: uri - .. autoattribute:: userData - .. autoattribute:: version - - .. rubric:: Methods Documentation - - .. automethod:: createFromJson diff --git a/gh-pages/_sources/api/mobase.ModState.rst.txt b/gh-pages/_sources/api/mobase.ModState.rst.txt deleted file mode 100644 index 28b6409..0000000 --- a/gh-pages/_sources/api/mobase.ModState.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ModState -======== - -.. currentmodule:: mobase - -.. autoclass:: ModState - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~ModState.ACTIVE - ~ModState.ALTERNATE - ~ModState.EMPTY - ~ModState.ENDORSED - ~ModState.ESSENTIAL - ~ModState.EXISTS - ~ModState.VALID - - .. rubric:: Attributes Documentation - - .. autoattribute:: ACTIVE - .. autoattribute:: ALTERNATE - .. autoattribute:: EMPTY - .. autoattribute:: ENDORSED - .. autoattribute:: ESSENTIAL - .. autoattribute:: EXISTS - .. autoattribute:: VALID diff --git a/gh-pages/_sources/api/mobase.PluginSetting.rst.txt b/gh-pages/_sources/api/mobase.PluginSetting.rst.txt deleted file mode 100644 index 2c0ab21..0000000 --- a/gh-pages/_sources/api/mobase.PluginSetting.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -PluginSetting -============= - -.. currentmodule:: mobase - -.. autoclass:: PluginSetting - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~PluginSetting.default_value - ~PluginSetting.description - ~PluginSetting.key - - .. rubric:: Attributes Documentation - - .. autoattribute:: default_value - .. autoattribute:: description - .. autoattribute:: key diff --git a/gh-pages/_sources/api/mobase.PluginState.rst.txt b/gh-pages/_sources/api/mobase.PluginState.rst.txt deleted file mode 100644 index 7c53489..0000000 --- a/gh-pages/_sources/api/mobase.PluginState.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -PluginState -=========== - -.. currentmodule:: mobase - -.. autoclass:: PluginState - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~PluginState.ACTIVE - ~PluginState.INACTIVE - ~PluginState.MISSING - - .. rubric:: Attributes Documentation - - .. autoattribute:: ACTIVE - .. autoattribute:: INACTIVE - .. autoattribute:: MISSING diff --git a/gh-pages/_sources/api/mobase.ProfileSetting.rst.txt b/gh-pages/_sources/api/mobase.ProfileSetting.rst.txt deleted file mode 100644 index 63af7c2..0000000 --- a/gh-pages/_sources/api/mobase.ProfileSetting.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ProfileSetting -============== - -.. currentmodule:: mobase - -.. autoclass:: ProfileSetting - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~ProfileSetting.CONFIGURATION - ~ProfileSetting.MODS - ~ProfileSetting.PREFER_DEFAULTS - ~ProfileSetting.SAVEGAMES - - .. rubric:: Attributes Documentation - - .. autoattribute:: CONFIGURATION - .. autoattribute:: MODS - .. autoattribute:: PREFER_DEFAULTS - .. autoattribute:: SAVEGAMES diff --git a/gh-pages/_sources/api/mobase.ReleaseType.rst.txt b/gh-pages/_sources/api/mobase.ReleaseType.rst.txt deleted file mode 100644 index a1ca1ee..0000000 --- a/gh-pages/_sources/api/mobase.ReleaseType.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -ReleaseType -=========== - -.. currentmodule:: mobase - -.. autoclass:: ReleaseType - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~ReleaseType.ALPHA - ~ReleaseType.BETA - ~ReleaseType.CANDIDATE - ~ReleaseType.FINAL - ~ReleaseType.PRE_ALPHA - - .. rubric:: Attributes Documentation - - .. autoattribute:: ALPHA - .. autoattribute:: BETA - .. autoattribute:: CANDIDATE - .. autoattribute:: FINAL - .. autoattribute:: PRE_ALPHA diff --git a/gh-pages/_sources/api/mobase.SaveGameInfo.rst.txt b/gh-pages/_sources/api/mobase.SaveGameInfo.rst.txt deleted file mode 100644 index 9e38a95..0000000 --- a/gh-pages/_sources/api/mobase.SaveGameInfo.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -SaveGameInfo -============ - -.. currentmodule:: mobase - -.. autoclass:: SaveGameInfo - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~SaveGameInfo.getMissingAssets - ~SaveGameInfo.getSaveGameInfo - ~SaveGameInfo.getSaveGameWidget - ~SaveGameInfo.hasScriptExtenderSave - - .. rubric:: Methods Documentation - - .. automethod:: getMissingAssets - .. automethod:: getSaveGameInfo - .. automethod:: getSaveGameWidget - .. automethod:: hasScriptExtenderSave diff --git a/gh-pages/_sources/api/mobase.ScriptExtender.rst.txt b/gh-pages/_sources/api/mobase.ScriptExtender.rst.txt deleted file mode 100644 index f31d04c..0000000 --- a/gh-pages/_sources/api/mobase.ScriptExtender.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -ScriptExtender -============== - -.. currentmodule:: mobase - -.. autoclass:: ScriptExtender - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ScriptExtender.BinaryName - ~ScriptExtender.PluginPath - ~ScriptExtender.getArch - ~ScriptExtender.getExtenderVersion - ~ScriptExtender.isInstalled - ~ScriptExtender.loaderName - ~ScriptExtender.loaderPath - ~ScriptExtender.saveGameAttachmentExtensions - - .. rubric:: Methods Documentation - - .. automethod:: BinaryName - .. automethod:: PluginPath - .. automethod:: getArch - .. automethod:: getExtenderVersion - .. automethod:: isInstalled - .. automethod:: loaderName - .. automethod:: loaderPath - .. automethod:: saveGameAttachmentExtensions diff --git a/gh-pages/_sources/api/mobase.SortMechanism.rst.txt b/gh-pages/_sources/api/mobase.SortMechanism.rst.txt deleted file mode 100644 index cf1b6df..0000000 --- a/gh-pages/_sources/api/mobase.SortMechanism.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -SortMechanism -============= - -.. currentmodule:: mobase - -.. autoclass:: SortMechanism - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~SortMechanism.BOSS - ~SortMechanism.LOOT - ~SortMechanism.MLOX - ~SortMechanism.NONE - - .. rubric:: Attributes Documentation - - .. autoattribute:: BOSS - .. autoattribute:: LOOT - .. autoattribute:: MLOX - .. autoattribute:: NONE diff --git a/gh-pages/_sources/api/mobase.UnmanagedMods.rst.txt b/gh-pages/_sources/api/mobase.UnmanagedMods.rst.txt deleted file mode 100644 index fde652a..0000000 --- a/gh-pages/_sources/api/mobase.UnmanagedMods.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -UnmanagedMods -============= - -.. currentmodule:: mobase - -.. autoclass:: UnmanagedMods - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~UnmanagedMods.displayName - ~UnmanagedMods.mods - ~UnmanagedMods.referenceFile - ~UnmanagedMods.secondaryFiles - - .. rubric:: Methods Documentation - - .. automethod:: displayName - .. automethod:: mods - .. automethod:: referenceFile - .. automethod:: secondaryFiles diff --git a/gh-pages/_sources/api/mobase.VersionInfo.rst.txt b/gh-pages/_sources/api/mobase.VersionInfo.rst.txt deleted file mode 100644 index a7f32f7..0000000 --- a/gh-pages/_sources/api/mobase.VersionInfo.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -VersionInfo -=========== - -.. currentmodule:: mobase - -.. autoclass:: VersionInfo - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~VersionInfo.canonicalString - ~VersionInfo.clear - ~VersionInfo.displayString - ~VersionInfo.isValid - ~VersionInfo.parse - ~VersionInfo.scheme - - .. rubric:: Methods Documentation - - .. automethod:: canonicalString - .. automethod:: clear - .. automethod:: displayString - .. automethod:: isValid - .. automethod:: parse - .. automethod:: scheme diff --git a/gh-pages/_sources/api/mobase.VersionScheme.rst.txt b/gh-pages/_sources/api/mobase.VersionScheme.rst.txt deleted file mode 100644 index 0e25c7b..0000000 --- a/gh-pages/_sources/api/mobase.VersionScheme.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -VersionScheme -============= - -.. currentmodule:: mobase - -.. autoclass:: VersionScheme - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~VersionScheme.DATE - ~VersionScheme.DECIMAL_MARK - ~VersionScheme.DISCOVER - ~VersionScheme.LITERAL - ~VersionScheme.NUMBERS_AND_LETTERS - ~VersionScheme.REGULAR - - .. rubric:: Attributes Documentation - - .. autoattribute:: DATE - .. autoattribute:: DECIMAL_MARK - .. autoattribute:: DISCOVER - .. autoattribute:: LITERAL - .. autoattribute:: NUMBERS_AND_LETTERS - .. autoattribute:: REGULAR diff --git a/gh-pages/_sources/api/mobase.getFileVersion.rst.txt b/gh-pages/_sources/api/mobase.getFileVersion.rst.txt deleted file mode 100644 index 06ee694..0000000 --- a/gh-pages/_sources/api/mobase.getFileVersion.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -getFileVersion -============== - -.. currentmodule:: mobase - -.. autofunction:: getFileVersion diff --git a/gh-pages/_sources/api/mobase.getIconForExecutable.rst.txt b/gh-pages/_sources/api/mobase.getIconForExecutable.rst.txt deleted file mode 100644 index f7ad7e7..0000000 --- a/gh-pages/_sources/api/mobase.getIconForExecutable.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -getIconForExecutable -==================== - -.. currentmodule:: mobase - -.. autofunction:: getIconForExecutable diff --git a/gh-pages/_sources/api/mobase.getProductVersion.rst.txt b/gh-pages/_sources/api/mobase.getProductVersion.rst.txt deleted file mode 100644 index a5bba5c..0000000 --- a/gh-pages/_sources/api/mobase.getProductVersion.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -getProductVersion -================= - -.. currentmodule:: mobase - -.. autofunction:: getProductVersion diff --git a/gh-pages/_sources/faq.rst.txt b/gh-pages/_sources/faq.rst.txt deleted file mode 100644 index de44220..0000000 --- a/gh-pages/_sources/faq.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -FAQ -=== - -.. toctree:: - :maxdepth: 4 - -1. Why is MO2 throwing an exception when I try to create a type inheriting one of MO2 class? -............................................................................................ - -This often happens if you forget to call ``super().__init__()`` with the right arguments. -Even if the list of arguments is empty (as in the example), it must be called due to a "bug" -in ``boost::python``: - -.. code-block:: python - - class MySaveGame(mobase.ISaveGame): - def __init__(self): - super().__init__() # Mandatory! - -2. How can I be sure to implement all the required methods when creating a plugin? -.................................................................................. - -It is kind of annoying to create a MO2 python plugin that kind of works and have it crash -at some point simply because there plugin is missing a function implementation. -You can have ``mypy`` warn you for such issue by typing the ``createPlugin`` or ``createPlugins`` -functions: - -.. code-block:: python - - import typing - - # A plugin that is missing something (e.g. display()). - class MyPlugin(mobase.IPluginTool): ... - - # If you type-hint `createPlugin` by adding `-> mobase.IPlugin`, - # `mypy` will warn you that `MyPlugin` is an incomplete class. - def createPlugin() -> mobase.IPlugin: - return MyPlugin() - - # You can also type-hint `createPlugins`: - def createPlugins() -> typing.List[mobase.IPlugin]: - return [MyPlugin()] - - -3. Why are my ``isinstance(x, QObject)`` and ``isinstance(y, QWidget)`` not working? -.................................................................................... - -Some classes from ``mobase`` are said to inherit ``QObject`` and ``QWidget`` in the -stubs, such as :class:`mobase.IDownloadManager`. -This is not the case in practice due to limitation in Python and ``boost::python``. -The bases are in the stubs to allow for auto-completion and typing, which is then -simulated in the real ``mobase`` by overriding ``__getattr__`` and delegating to -the underlying ``QObject`` or ``QWidget``. \ No newline at end of file diff --git a/gh-pages/_sources/index.rst.txt b/gh-pages/_sources/index.rst.txt deleted file mode 100644 index ef93b56..0000000 --- a/gh-pages/_sources/index.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -.. MO2 Python Plugin API documentation master file, created by - sphinx-quickstart on Wed Jul 15 19:36:59 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to MO2 Python Plugin API's documentation! -================================================= - -Plugins are a way to extend Mod Organizers functionality. You can write plugins in either C++ or Python, -theoretically with either being as powerful as the other. -This documentation is dedicated to writting MO2 **Python** plugins. - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - setup-tools - plugin-types - writing-plugins - faq - mobase - - - -.. Indices and tables -.. ================== - -.. * :ref:`genindex` -.. * :ref:`modindex` -.. * :ref:`search` diff --git a/gh-pages/_sources/mobase.rst.txt b/gh-pages/_sources/mobase.rst.txt deleted file mode 100644 index 26a456f..0000000 --- a/gh-pages/_sources/mobase.rst.txt +++ /dev/null @@ -1,11 +0,0 @@ -``mobase`` API -============== - -.. currentmodule:: mobase - -.. automodapi:: mobase - :no-inheritance-diagram: - :no-heading: - -.. toctree:: - :maxdepth: 4 diff --git a/gh-pages/_sources/modules.rst.txt b/gh-pages/_sources/modules.rst.txt deleted file mode 100644 index 2b6dad5..0000000 --- a/gh-pages/_sources/modules.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -mobase -====== - -.. toctree:: - :maxdepth: 4 - - mobase diff --git a/gh-pages/_sources/plugin-types.rst.txt b/gh-pages/_sources/plugin-types.rst.txt deleted file mode 100644 index c41cbc0..0000000 --- a/gh-pages/_sources/plugin-types.rst.txt +++ /dev/null @@ -1,150 +0,0 @@ -.. _type-of-plugins: - -Type of Plugins -=============== - -Plugins are passive, that is: they react to events emitted by the core application or extend -an existing functionality (like adding support for additional types of installers). Plugins -should integrate with Mod Organizers concepts. While you could write an INI editor that works with -the global INI files instead of the profile specific ones, what would be the point? - -Depending on where/how the plugin integrates with MO you need to write a different type of plugin, -in practice this means you need to implement a different interface (inherit from a different base -plugin class from ``mobase``). As mentioned above, plugins are passive: the plugin type decides how/when -MO makes requests to/invokes your plugin. -All plugins however gain access to MOs own plugin interface so all plugins get to make the same requests -to MO. - -Installers ----------- - -| **Interface:** :class:`IPluginInstaller`, :class:`IPluginInstallerSimple`, - :class:`IPluginInstallerCustom` -| **Examples:** ``installer_bain``, ``installer_bundle``, ``installer_fomod``, ``installer_ncc``, ``installer_quick``, ``installer_manual``. - -An installer is invoked when the user tries to install a mod, either by double clicking in the download -view or through the "Install Mod.." button or "Reinstall mod" item from the mod lists context menu. -There are actually two ways to write an installer, *simple* or *complex*: - -- With *simple* installers, MO does the unpacking of the file but this works only with standard archive formats. - The plugin can then select the files and folders that requires extraction, and where to extract them. -- *Complex* installers are more flexible but require a bit more work. - -Previewers ----------- - -| **Interfaces:** :class:`IPluginPreview` -| **Examples:** ``preview_base`` - -These plugins add support for previewing files in the data pane. -Right now all image formats supported by Qt are implemented (including `.dds`) but no audio files and -no 3d mesh formats. - -Mod Page --------- - -*WIP* - -| **Interfaces:** :class:`IPluginModPage` -| **Examples:** ``page_tesalliance`` - -Mod Page plugins implement interfaces to modding communities where mods can be downloaded, checked -for updates and so on. -This interface is not finished and some of the bits that are do not actually get used. The goal is -that the whole Nexus integration can be implemented through this interface and can then be removed -from the core application. This is a task for the distant future, unless someone wants to volunteer. - -Game ----- - -| **Interfaces:** :class:`IPluginGame` -| **Examples:** ``game_oblivion``, ``game_fallout3``, ``game_falloutnv``, ``game_skyrim``, ... - -These plugins (shall eventually) implement all the game specific features and further game plugins are -able to add support for further games. -The plugin is also responsible to help MO determine if (and where) the game is installed in the first place. -Since supporting a game properly requires extensions in many places of the UI. -To allow this without creating one huge plugin interface that involves every aspect of MO, game plugins -expose a *feature list*. -The list of possible features can be found in the "game_features" project and each feature can itself be -considered a plugin interface. - -As an example for a game feature take BSA invalidation: If the game requires BSA invalidation it will implement -this feature. -Wherever the core can support BSA invalidation it will query whether the current game has this feature and if so -query the implementation on specifics (like "How should the invalidation BSA be called" and "what's the right bsa version"). -Of course, the goal is for feature interfaces to be as generic as possible without limiting usefulness. - -**Note:** The :class:`IPluginGame` interface is complex, and mostly designed for Gamebryo games. If you plan -on writting a game plugin for another type of games, you might be interested by a simpler interface and might -want to check out the `Basic Games `_ meta-plugin. - - -Tool ----- - -| **Interfaces:** :class:`IPluginTool` -| **Examples:** ``tool_configurator``, ``tool_inieditor``, ``fnistool`` - -This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools submenu and get -invoked when the user clicks it. They are expected to have a user interface of some sort. -These are almost like independent applications except they can access all Mod Organizer interfaces like querying -and modifying the current profile, mod list, load order, use MO to install mods and so on. -A tool plugin can (and should!) integrate its UI as a window inside MO and thus doesn't have to initialize a -windows application itself. - -Proxies -------- - -| **Interfaces:** :class:`IPluginProxy` -| **Examples:** ``plugin_python`` - -Proxy Plugins expose the plugin api to foreign languages. This is what allows you to write plugins using python -in the first place. -The python proxy is easily the most complicated plugin and requires constant updating so if you're considering -writing a Haskell plugin because that is your programming language of choice, I am fairly certain learning python -is easier than writing the haskell proxy. Just saying. -And no, you can not write a proxy for a third language in Python, do not be silly. - -*Free Plugins* --------------- - -| **Interfaces:** :class:`IPlugin` -| **Examples:** ``check_fnis``, ``bsa_extractor``, ``diagnose_basic``, ``tool_inibakery`` - -"Free" plugins implement none of the interfaces and thus initially do not integrate with MO at all. -They are initialized by MO and get access to the MO interface. -This makes sense if you only want to implement one of the extension interfaces (see below) or register handlers -for events. - -Extension Interfaces --------------------- - -In Python, these interfaces are similar to other plugin types, but in C++, those do not inherit ``IPlugin`` so -that plugins can implement one or more of these interfaces, in addition to a normal plugin type. - -Diagnose -........ - -| **Interfaces:** :class:`IPluginDiagnose` -| **Examples:** ``diagnose_basic``, ``installer_ncc``, ``plugin_python``, ``script_extender_plugin_checker`` - -This interface lets the plugin report issues that are then listed in the "Problems" icon in the main window. -If possible the plugin can also provide an automatic or guided fix to the problem. -The ``diagnose_basic`` plugin does nothing but analyze the MO installation and report problems it discovers (like -*"There are files in your overwrite directory."*) but usually a plugin will want to report issues relevant for its -own operation. -For instance, ``installer_ncc`` requires a specific version of .NET and will report a problem if it is not installed. -This should always be the prefered way to communicate problems the user has to fix but should never be used for problems -he cannot fix (i.e. *"This plugin does not work with this game."*). -An empty problem list should always be achievable. - -File Mappings -............. - -| **Interfaces:** :class:`IPluginFileMapper` -| **Examples:** ``tool_inibakery``, ``game_gamebryo`` - -This interface allows plugins to add virtual file (or directory) links to the virtual file system in addition to the -mod files. -Profile-local save games, ini-files and load-orders are all implemented this way in MO2. \ No newline at end of file diff --git a/gh-pages/_sources/setup-tools.rst.txt b/gh-pages/_sources/setup-tools.rst.txt deleted file mode 100644 index 15c5aab..0000000 --- a/gh-pages/_sources/setup-tools.rst.txt +++ /dev/null @@ -1,135 +0,0 @@ -Setting up the environment -========================== - -This page will get you started for creating a MO2 python plugin. If you have troubles getting -everything setup, feel free to come by our discord server at `https://discord.gg/cYwdcxj `_. - -Required tools --------------- - -It is possible to write a MO2 python plugin using any text editor, but this guide will focus on -`Visual Studio Code `_. -This guide assumes that: - -- You have `Visual Studio Code `_ installed with the - `Python extension `_. -- You have Python installed: https://www.python.org/downloads/. - - - It is recommended but not mandatory to use the Python version that is used by MO2. - You can check the ``pythonXX.dll`` in the MO2 installation folder to find the Python version used by MO2 (``python38.dll`` means Python 3.8). -- You obviously need a valid MO2 installation: https://github.com/modorganizer2/modorganizer/releases - - - This guide is written for MO2 ā‰„ 2.3.0. - -**Note:** In the following, I will refer to the MO2 installation directory as ``$MO2DIR``. So if you -installed MO2 at ``C:\MO2`` and you are asked to copy a file to ``$MO2DIR/plugins``, it refers to ``C:\MO2\plugins``. - -Preparation ------------ - -**Note:** This part is optional but highly recommended if you want a proper environment to work with. -Everything here is written to be as simple as possible but you can of course adapt it to your preferences: use a python virtual -environment, use workspace settings instead of global ones, etc. - -1. Get the ``mobase`` stubs -........................... - -``mobase`` is the MO2 Python module. The module is written in C++ and thus cannot be read directly by tools such -as ``flake8`` or ``mypy``. -Instead, we provide `stubs `_ -which can be used for auto-completion or type-checking. - -The stubs for ``mobase`` are available at https://github.com/ModOrganizer2/pystubs-generation/tree/master/stubs. -You want to download the ``mobase.pyi`` file in the folder corresponding to your MO2 version and put it under ``$MO2DIR/plugins/data``. - -**Note:** It is possible to put the stubs in a different location, but we are going to use ``$MO2DIR/plugins/data`` for PyQt5, -so we might as well use it for the stubs. - -2. Configure Visual Studio Code for ``mobase`` -.............................................. - -We are going to configure Visual Studio Code to have auto-completion and linting (error and type checking) -for the MO2 Python module. -Open ``settings.json`` (Ctrl+Shift+P, then "Open Settings (JSON)"), and add the following entries: - -.. code-block:: json-object - - "python.linting.enabled": true, - "python.linting.mypyEnabled": true, - "python.linting.flake8Enabled": true, - "python.autoComplete.extraPaths": [ - "$MO2DIR\\plugins\\data", - ] - -3. Configure ``mypy`` to find the ``mobase`` stubs -.................................................. - -There are multiply way to configure ``mypy``: - -1. You can create a ``mypy.ini`` file somewhere containing: - -.. code-block:: ini - - [mypy] - mypy_path = $MO2DIR\plugins\data - -And then add the following to ``settings.json`` (with the correct path): - -.. code-block:: json-object - - "python.linting.mypyArgs": [ - "--config-file=path-to-mypy.ini", - ] - -2. You can set the ``MYPYPATH`` environment variable to ``$MO2DIR\plugins\data`` (this requires -restarting VS code). - -Testing the setup ------------------ - -Create a new Python file in Visual Studio Code, and paste the following content (if you create -the file in ``$MO2DIR\plugins``, do not forget to delete it after since it is not a valid -plugin): - -.. code-block:: python - - import mobase - - - class MyPlugin(mobase.IPluginTool): - def __init__(self): - super().__init__() - - def init(self, organizer: mobase.IOrganizer) -> bool: - organizer.dow # (1) - return True - - def name(self) -> int: - return 0 - - - def createPlugin() -> mobase.IPlugin: - return MyPlugin() - - -If your setup is valid, here is what you should have. - -- You should see the following (with the errors underlined): - -.. image:: images/check-setup-1.png - -- If you press ``Ctrl+Space`` after ``.down`` (1), you should see the following - meaning that auto-complete is working: - -.. image:: images/check-setup-2.png - -- In the error window (click |error-window| on the status bar), you should see - the 3 following errors: - -.. image:: images/check-setup-3.png - -If everything is as above, you can delete the test file and move on to writting -your own plugin! - - -.. |error-window| image:: images/error-window.png \ No newline at end of file diff --git a/gh-pages/_sources/writing-plugins.rst.txt b/gh-pages/_sources/writing-plugins.rst.txt deleted file mode 100644 index 153ecfb..0000000 --- a/gh-pages/_sources/writing-plugins.rst.txt +++ /dev/null @@ -1,201 +0,0 @@ -Writing Plugins -=============== - -Getting started ---------------- - -Now that you know which type of plugin you need, you can start writing your own plugin. -There is two way to write a Python plugin: - -- :ref:`single-file-plugin`: You use a single ``.py`` file that you put directly in the ``plugins`` - folder of the MO2 installation. -- :ref:`module-plugin`: You create a Python package (folder) with a ``__init__.py`` file that you - put in the ``plugins`` folder of the MO2 installation. - -Most examples of plugins will be module plugins. - -.. _single-file-plugin: - -Single file plugins -................... - -Prior to version 2.3, this was the only way of creating a Python plugin. You simply need -to create a ``myplugin.py`` file in the ``plugins`` folder of Mod Organizer 2 with a content -similar to: - -.. code-block:: python - - import mobase - - class MyPlugin(...): - ... - - def createPlugin() -> mobase.IPlugin: - return MyPlugin() - -We will see later on how to create the actual ``MyPlugin`` class. -The ``createPlugin`` function is the function that is called by Mod Organizer 2 to instantiate -the plugin. - -You can also provide multiple plugins by using ``createPlugins`` instead of ``createPlugin``: - -.. code-block:: python - - from typing import List - - import mobase - - class MyPlugin1(...): - ... - - class MyPlugin2(...): - ... - - - def createPlugins() -> List[mobase.IPlugin]: - return [MyPlugin1(), MyPlugin2()] - -**Note:** If you provide neither ``createPlugin()`` nor ``createPlugins``, MO2 will display -an error message in the logs. - -**Note:** If you add a return type-hint to ``createPlugin()`` or ``createPlugins`` (``->``), ``mypy`` -will type-check the function and warn you if one of your plugins is invalid, e.g. if you -forgot to implement a required method. - -If you need to provide other files with your ``.py`` (assets or other Python files), you can -put them in the ``plugins/data``, but this is deprecated since MO2 2.3, and you should instead -create a Python module plugin. - -.. _module-plugin: - -Module Plugins -.............. - -Module plugins were introduced in MO2 2.3 and are shipped as whole folder containg a python module. -The minimum content of the folder is a ``__init__.py`` file with ``createPlugin`` or ``createPlugins`` -function. - -A minimal module plugin could be as follows: - -.. code-block:: bash - - plugins/ # MO2 plugins folder - myplugin/ - __init__.py - plugin.py - -In ``plugin.py``, you could define your plugin: - -.. code-block:: python - - # plugin.py - - import mobase - - class MyPlugin(...): - ... - -And in ``__init__.py``, you should write ``createPlugin``: - -.. code-block:: python - - # __init__.py - - import mobase # For type-checking createPlugin(). - - from .plugin import MyPlugin # Always use relative import: - - def createPlugin() -> mobase.IPlugin: - return MyPlugin() - -Similar to single-file plugins, you can expose ``createPlugins`` instead of ``createPlugin`` -to instantiate multiple plugins. - -**Note:** The name of the folder does not have to be a valid python package, and you should -always use relative imports within the module (``import .xxx``) instead of absolute ones. - -Writing the plugin ------------------- - -``IPlugin`` interface -..................... - -In the code snippets above, the ``MyPlugin`` class was not implemented. -Depending on the :ref:`type of plugins` that you want to create, you will -need to extend a different class. - -.. code-block:: python - - class MyTool(mobase.IPluginTool): # Create a Tool plugin - ... - - class MyPreview(mobase.IPluginPreview): # Create a preview plugin - ... - -Each plugin class has its own abstract methods that you need to implement but all the classes -also extend ``IPlugin``, so you need to implement the methods from :class:`IPlugin`: - -.. code-block:: python - - from typing import List - - import mobase - - class MyPlugin(...): # The base class depends on the actual type of plugin - - _organizer: mobase.IOrganizer - - def __init__(self): - super().__init__() # You need to call this manually. - - def init(self, organizer: mobase.IOrganizer): - self._organizer = organizer - return True - - def name(self) -> str: - return "" - - def author(self) -> str: - return "Tannin" - - def description(self) -> str: - return self._tr("Gives a friendly greeting") - - def version(self) -> mobase.VersionInfo: - return mobase.VersionInfo(1, 0, 0, mobase.ReleaseType.FINAL) - - def isActive(self) -> bool: - return self._organizer.pluginSetting(self.name(), "enabled") - - def settings(self) -> List[mobase.PluginSetting]: - return [ - mobase.PluginSetting("enabled", "enable this plugin", True) - ] - -Most of these are pretty simple to understand: - -- ``name``: Returns the name of the plugin. The name of the plugin is used to - fetch settings, and in many places, so this should not change between versions. -- ``author``: Returns the name of the plugin author (you!). -- ``description``: Returns the description of the plugin. -- ``version``: Returns the version of the plugin. See :class:`VersionInfo` for - more details. -- ``isActive``: Returns ``True`` if the plugin is active, ``False`` otherwise. This - usually returns ``True``, unless you want to check for something to dynamically - enable the plugin. You can also use a plugin setting to allow users to disable - your plugins. -- ``settings``: Returns the list of settings (that user can modify) for this plugin. - Settings can be ``int```, ``bool``, ``str`` or list of ``str``. Here we indicate - that we have a "enabled" setting that user could use to disable the plugin (and - we use it in ``isActive``). - - -The ``__init__`` method is the normal Python constructor for our plugin, called when doing -``MyPlugin()``. -You should always call ``super().__init__()`` explicitly when extending MO2 classes (due to -a "bug" in ``boost.python``). - -The ``init`` method is called by MO2 to initialize the plugin. The given argument, ``organizer``, -is an instance of :class:`IOrganizer` which is the class used to interface with MO2. -Here, we use it in the ``isActive()`` method to retrieve the "enabled" setting for our plugin. -See :class:`IOrganizer` for more details. \ No newline at end of file diff --git a/gh-pages/_static/basic.css b/gh-pages/_static/basic.css deleted file mode 100644 index 0119285..0000000 --- a/gh-pages/_static/basic.css +++ /dev/null @@ -1,768 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; - word-wrap: break-word; - overflow-wrap : break-word; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox form.search { - overflow: hidden; -} - -div.sphinxsidebar #searchbox input[type="text"] { - float: left; - width: 80%; - padding: 0.25em; - box-sizing: border-box; -} - -div.sphinxsidebar #searchbox input[type="submit"] { - float: left; - width: 20%; - border-left: none; - padding: 0.25em; - box-sizing: border-box; -} - - -img { - border: 0; - max-width: 100%; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; - margin-left: auto; - margin-right: auto; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable ul { - margin-top: 0; - margin-bottom: 0; - list-style-type: none; -} - -table.indextable > tbody > tr > td > ul { - padding-left: 0em; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- domain module index --------------------------------------------------- */ - -table.modindextable td { - padding: 2px; - border-collapse: collapse; -} - -/* -- general body styles --------------------------------------------------- */ - -div.body { - min-width: 450px; - max-width: 800px; -} - -div.body p, div.body dd, div.body li, div.body blockquote { - -moz-hyphens: auto; - -ms-hyphens: auto; - -webkit-hyphens: auto; - hyphens: auto; -} - -a.headerlink { - visibility: hidden; -} - -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink, -caption:hover > a.headerlink, -p.caption:hover > a.headerlink, -div.code-block-caption:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -img.align-default, .figure.align-default { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-default { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px 7px 0 7px; - background-color: #ffe; - width: 40%; - float: right; -} - -p.sidebar-title { - font-weight: bold; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 1px solid #ccc; - padding: 7px 7px 0 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -div.admonition dl { - margin-bottom: 0; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - border: 0; - border-collapse: collapse; -} - -table.align-center { - margin-left: auto; - margin-right: auto; -} - -table.align-default { - margin-left: auto; - margin-right: auto; -} - -table caption span.caption-number { - font-style: italic; -} - -table caption span.caption-text { -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -th > p:first-child, -td > p:first-child { - margin-top: 0px; -} - -th > p:last-child, -td > p:last-child { - margin-bottom: 0px; -} - -/* -- figures --------------------------------------------------------------- */ - -div.figure { - margin: 0.5em; - padding: 0.5em; -} - -div.figure p.caption { - padding: 0.3em; -} - -div.figure p.caption span.caption-number { - font-style: italic; -} - -div.figure p.caption span.caption-text { -} - -/* -- field list styles ----------------------------------------------------- */ - -table.field-list td, table.field-list th { - border: 0 !important; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -/* -- hlist styles ---------------------------------------------------------- */ - -table.hlist td { - vertical-align: top; -} - - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -li > p:first-child { - margin-top: 0px; -} - -li > p:last-child { - margin-bottom: 0px; -} - -dl.footnote > dt, -dl.citation > dt { - float: left; -} - -dl.footnote > dd, -dl.citation > dd { - margin-bottom: 0em; -} - -dl.footnote > dd:after, -dl.citation > dd:after { - content: ""; - clear: both; -} - -dl.field-list { - display: grid; - grid-template-columns: fit-content(30%) auto; -} - -dl.field-list > dt { - font-weight: bold; - word-break: break-word; - padding-left: 0.5em; - padding-right: 5px; -} - -dl.field-list > dt:after { - content: ":"; -} - -dl.field-list > dd { - padding-left: 0.5em; - margin-top: 0em; - margin-left: 0em; - margin-bottom: 0em; -} - -dl { - margin-bottom: 15px; -} - -dd > p:first-child { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dt:target, span.highlighted { - background-color: #fbe54e; -} - -rect.highlighted { - fill: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.optional { - font-size: 1.3em; -} - -.sig-paren { - font-size: larger; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -.classifier:before { - font-style: normal; - margin: 0.5em; - content: ":"; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -span.pre { - -moz-hyphens: none; - -ms-hyphens: none; - -webkit-hyphens: none; - hyphens: none; -} - -td.linenos pre { - padding: 5px 0px; - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - margin-left: 0.5em; -} - -table.highlighttable td { - padding: 0 0.5em 0 0.5em; -} - -div.code-block-caption { - padding: 2px 5px; - font-size: small; -} - -div.code-block-caption code { - background-color: transparent; -} - -div.code-block-caption + div > div.highlight > pre { - margin-top: 0; -} - -div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ - user-select: none; -} - -div.code-block-caption span.caption-number { - padding: 0.1em 0.3em; - font-style: italic; -} - -div.code-block-caption span.caption-text { -} - -div.literal-block-wrapper { - padding: 1em 1em 0; -} - -div.literal-block-wrapper div.highlight { - margin: 0; -} - -code.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; -} - -code.descclassname { - background-color: transparent; -} - -code.xref, a code { - background-color: transparent; - font-weight: bold; -} - -h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -span.eqno a.headerlink { - position: relative; - left: 0px; - z-index: 1; -} - -div.math:hover a.headerlink { - visibility: visible; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} \ No newline at end of file diff --git a/gh-pages/_static/css/badge_only.css b/gh-pages/_static/css/badge_only.css deleted file mode 100644 index e380325..0000000 --- a/gh-pages/_static/css/badge_only.css +++ /dev/null @@ -1 +0,0 @@ -.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/gh-pages/_static/css/fonts/Roboto-Slab-Bold.woff b/gh-pages/_static/css/fonts/Roboto-Slab-Bold.woff deleted file mode 100644 index 6cb6000..0000000 Binary files a/gh-pages/_static/css/fonts/Roboto-Slab-Bold.woff and /dev/null differ diff --git a/gh-pages/_static/css/fonts/Roboto-Slab-Bold.woff2 b/gh-pages/_static/css/fonts/Roboto-Slab-Bold.woff2 deleted file mode 100644 index 7059e23..0000000 Binary files a/gh-pages/_static/css/fonts/Roboto-Slab-Bold.woff2 and /dev/null differ diff --git a/gh-pages/_static/css/fonts/Roboto-Slab-Regular.woff b/gh-pages/_static/css/fonts/Roboto-Slab-Regular.woff deleted file mode 100644 index f815f63..0000000 Binary files a/gh-pages/_static/css/fonts/Roboto-Slab-Regular.woff and /dev/null differ diff --git a/gh-pages/_static/css/fonts/Roboto-Slab-Regular.woff2 b/gh-pages/_static/css/fonts/Roboto-Slab-Regular.woff2 deleted file mode 100644 index f2c76e5..0000000 Binary files a/gh-pages/_static/css/fonts/Roboto-Slab-Regular.woff2 and /dev/null differ diff --git a/gh-pages/_static/css/fonts/fontawesome-webfont.eot b/gh-pages/_static/css/fonts/fontawesome-webfont.eot deleted file mode 100644 index e9f60ca..0000000 Binary files a/gh-pages/_static/css/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/gh-pages/_static/css/fonts/fontawesome-webfont.svg b/gh-pages/_static/css/fonts/fontawesome-webfont.svg deleted file mode 100644 index 855c845..0000000 --- a/gh-pages/_static/css/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,2671 +0,0 @@ - - - - -Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 - By ,,, -Copyright Dave Gandy 2016. All rights reserved. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/gh-pages/_static/css/fonts/fontawesome-webfont.ttf b/gh-pages/_static/css/fonts/fontawesome-webfont.ttf deleted file mode 100644 index 35acda2..0000000 Binary files a/gh-pages/_static/css/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/gh-pages/_static/css/fonts/fontawesome-webfont.woff b/gh-pages/_static/css/fonts/fontawesome-webfont.woff deleted file mode 100644 index 400014a..0000000 Binary files a/gh-pages/_static/css/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/gh-pages/_static/css/fonts/fontawesome-webfont.woff2 b/gh-pages/_static/css/fonts/fontawesome-webfont.woff2 deleted file mode 100644 index 4d13fc6..0000000 Binary files a/gh-pages/_static/css/fonts/fontawesome-webfont.woff2 and /dev/null differ diff --git a/gh-pages/_static/css/fonts/lato-bold-italic.woff b/gh-pages/_static/css/fonts/lato-bold-italic.woff deleted file mode 100644 index 88ad05b..0000000 Binary files a/gh-pages/_static/css/fonts/lato-bold-italic.woff and /dev/null differ diff --git a/gh-pages/_static/css/fonts/lato-bold-italic.woff2 b/gh-pages/_static/css/fonts/lato-bold-italic.woff2 deleted file mode 100644 index c4e3d80..0000000 Binary files a/gh-pages/_static/css/fonts/lato-bold-italic.woff2 and /dev/null differ diff --git a/gh-pages/_static/css/fonts/lato-bold.woff b/gh-pages/_static/css/fonts/lato-bold.woff deleted file mode 100644 index c6dff51..0000000 Binary files a/gh-pages/_static/css/fonts/lato-bold.woff and /dev/null differ diff --git a/gh-pages/_static/css/fonts/lato-bold.woff2 b/gh-pages/_static/css/fonts/lato-bold.woff2 deleted file mode 100644 index bb19504..0000000 Binary files a/gh-pages/_static/css/fonts/lato-bold.woff2 and /dev/null differ diff --git a/gh-pages/_static/css/fonts/lato-normal-italic.woff b/gh-pages/_static/css/fonts/lato-normal-italic.woff deleted file mode 100644 index 76114bc..0000000 Binary files a/gh-pages/_static/css/fonts/lato-normal-italic.woff and /dev/null differ diff --git a/gh-pages/_static/css/fonts/lato-normal-italic.woff2 b/gh-pages/_static/css/fonts/lato-normal-italic.woff2 deleted file mode 100644 index 3404f37..0000000 Binary files a/gh-pages/_static/css/fonts/lato-normal-italic.woff2 and /dev/null differ diff --git a/gh-pages/_static/css/fonts/lato-normal.woff b/gh-pages/_static/css/fonts/lato-normal.woff deleted file mode 100644 index ae1307f..0000000 Binary files a/gh-pages/_static/css/fonts/lato-normal.woff and /dev/null differ diff --git a/gh-pages/_static/css/fonts/lato-normal.woff2 b/gh-pages/_static/css/fonts/lato-normal.woff2 deleted file mode 100644 index 3bf9843..0000000 Binary files a/gh-pages/_static/css/fonts/lato-normal.woff2 and /dev/null differ diff --git a/gh-pages/_static/css/theme.css b/gh-pages/_static/css/theme.css deleted file mode 100644 index 8cd4f10..0000000 --- a/gh-pages/_static/css/theme.css +++ /dev/null @@ -1,4 +0,0 @@ -html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li span.toctree-expand:before,.wy-nav-top a,.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! - * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome - * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) - */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li span.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li span.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li span.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li span.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li span.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:"ļ€€"}.fa-music:before{content:"ļ€"}.fa-search:before,.icon-search:before{content:"ļ€‚"}.fa-envelope-o:before{content:"ļ€ƒ"}.fa-heart:before{content:"ļ€„"}.fa-star:before{content:"ļ€…"}.fa-star-o:before{content:"ļ€†"}.fa-user:before{content:"ļ€‡"}.fa-film:before{content:"ļ€ˆ"}.fa-th-large:before{content:"ļ€‰"}.fa-th:before{content:"ļ€Š"}.fa-th-list:before{content:"ļ€‹"}.fa-check:before{content:"ļ€Œ"}.fa-close:before,.fa-remove:before,.fa-times:before{content:"ļ€"}.fa-search-plus:before{content:"ļ€Ž"}.fa-search-minus:before{content:"ļ€"}.fa-power-off:before{content:"ļ€‘"}.fa-signal:before{content:"ļ€’"}.fa-cog:before,.fa-gear:before{content:"ļ€“"}.fa-trash-o:before{content:"ļ€”"}.fa-home:before,.icon-home:before{content:"ļ€•"}.fa-file-o:before{content:"ļ€–"}.fa-clock-o:before{content:"ļ€—"}.fa-road:before{content:"ļ€˜"}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:"ļ€™"}.fa-arrow-circle-o-down:before{content:"ļ€š"}.fa-arrow-circle-o-up:before{content:"ļ€›"}.fa-inbox:before{content:"ļ€œ"}.fa-play-circle-o:before{content:"ļ€"}.fa-repeat:before,.fa-rotate-right:before{content:"ļ€ž"}.fa-refresh:before{content:"ļ€”"}.fa-list-alt:before{content:"ļ€¢"}.fa-lock:before{content:"ļ€£"}.fa-flag:before{content:"ļ€¤"}.fa-headphones:before{content:"ļ€„"}.fa-volume-off:before{content:"ļ€¦"}.fa-volume-down:before{content:"ļ€§"}.fa-volume-up:before{content:"ļ€Ø"}.fa-qrcode:before{content:"ļ€©"}.fa-barcode:before{content:"ļ€Ŗ"}.fa-tag:before{content:"ļ€«"}.fa-tags:before{content:"ļ€¬"}.fa-book:before,.icon-book:before{content:"ļ€­"}.fa-bookmark:before{content:"ļ€®"}.fa-print:before{content:"ļ€Æ"}.fa-camera:before{content:"ļ€°"}.fa-font:before{content:"ļ€±"}.fa-bold:before{content:"ļ€²"}.fa-italic:before{content:"ļ€³"}.fa-text-height:before{content:"ļ€“"}.fa-text-width:before{content:"ļ€µ"}.fa-align-left:before{content:"ļ€¶"}.fa-align-center:before{content:"ļ€·"}.fa-align-right:before{content:"ļ€ø"}.fa-align-justify:before{content:"ļ€¹"}.fa-list:before{content:"ļ€ŗ"}.fa-dedent:before,.fa-outdent:before{content:"ļ€»"}.fa-indent:before{content:"ļ€¼"}.fa-video-camera:before{content:"ļ€½"}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:"ļ€¾"}.fa-pencil:before{content:"ļ€"}.fa-map-marker:before{content:"ļ"}.fa-adjust:before{content:"ļ‚"}.fa-tint:before{content:"ļƒ"}.fa-edit:before,.fa-pencil-square-o:before{content:"ļ„"}.fa-share-square-o:before{content:"ļ…"}.fa-check-square-o:before{content:"ļ†"}.fa-arrows:before{content:"ļ‡"}.fa-step-backward:before{content:"ļˆ"}.fa-fast-backward:before{content:"ļ‰"}.fa-backward:before{content:"ļŠ"}.fa-play:before{content:"ļ‹"}.fa-pause:before{content:"ļŒ"}.fa-stop:before{content:"ļ"}.fa-forward:before{content:"ļŽ"}.fa-fast-forward:before{content:"ļ"}.fa-step-forward:before{content:"ļ‘"}.fa-eject:before{content:"ļ’"}.fa-chevron-left:before{content:"ļ“"}.fa-chevron-right:before{content:"ļ”"}.fa-plus-circle:before{content:"ļ•"}.fa-minus-circle:before{content:"ļ–"}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:"ļ—"}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:"ļ˜"}.fa-question-circle:before{content:"ļ™"}.fa-info-circle:before{content:"ļš"}.fa-crosshairs:before{content:"ļ›"}.fa-times-circle-o:before{content:"ļœ"}.fa-check-circle-o:before{content:"ļ"}.fa-ban:before{content:"ļž"}.fa-arrow-left:before{content:"ļ "}.fa-arrow-right:before{content:"ļ”"}.fa-arrow-up:before{content:"ļ¢"}.fa-arrow-down:before{content:"ļ£"}.fa-mail-forward:before,.fa-share:before{content:"ļ¤"}.fa-expand:before{content:"ļ„"}.fa-compress:before{content:"ļ¦"}.fa-plus:before{content:"ļ§"}.fa-minus:before{content:"ļØ"}.fa-asterisk:before{content:"ļ©"}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:"ļŖ"}.fa-gift:before{content:"ļ«"}.fa-leaf:before{content:"ļ¬"}.fa-fire:before,.icon-fire:before{content:"ļ­"}.fa-eye:before{content:"ļ®"}.fa-eye-slash:before{content:"ļ°"}.fa-exclamation-triangle:before,.fa-warning:before{content:"ļ±"}.fa-plane:before{content:"ļ²"}.fa-calendar:before{content:"ļ³"}.fa-random:before{content:"ļ“"}.fa-comment:before{content:"ļµ"}.fa-magnet:before{content:"ļ¶"}.fa-chevron-up:before{content:"ļ·"}.fa-chevron-down:before{content:"ļø"}.fa-retweet:before{content:"ļ¹"}.fa-shopping-cart:before{content:"ļŗ"}.fa-folder:before{content:"ļ»"}.fa-folder-open:before{content:"ļ¼"}.fa-arrows-v:before{content:"ļ½"}.fa-arrows-h:before{content:"ļ¾"}.fa-bar-chart-o:before,.fa-bar-chart:before{content:"ļ‚€"}.fa-twitter-square:before{content:"ļ‚"}.fa-facebook-square:before{content:"ļ‚‚"}.fa-camera-retro:before{content:"ļ‚ƒ"}.fa-key:before{content:"ļ‚„"}.fa-cogs:before,.fa-gears:before{content:"ļ‚…"}.fa-comments:before{content:"ļ‚†"}.fa-thumbs-o-up:before{content:"ļ‚‡"}.fa-thumbs-o-down:before{content:"ļ‚ˆ"}.fa-star-half:before{content:"ļ‚‰"}.fa-heart-o:before{content:"ļ‚Š"}.fa-sign-out:before{content:"ļ‚‹"}.fa-linkedin-square:before{content:"ļ‚Œ"}.fa-thumb-tack:before{content:"ļ‚"}.fa-external-link:before{content:"ļ‚Ž"}.fa-sign-in:before{content:"ļ‚"}.fa-trophy:before{content:"ļ‚‘"}.fa-github-square:before{content:"ļ‚’"}.fa-upload:before{content:"ļ‚“"}.fa-lemon-o:before{content:"ļ‚”"}.fa-phone:before{content:"ļ‚•"}.fa-square-o:before{content:"ļ‚–"}.fa-bookmark-o:before{content:"ļ‚—"}.fa-phone-square:before{content:"ļ‚˜"}.fa-twitter:before{content:"ļ‚™"}.fa-facebook-f:before,.fa-facebook:before{content:"ļ‚š"}.fa-github:before,.icon-github:before{content:"ļ‚›"}.fa-unlock:before{content:"ļ‚œ"}.fa-credit-card:before{content:"ļ‚"}.fa-feed:before,.fa-rss:before{content:"ļ‚ž"}.fa-hdd-o:before{content:"ļ‚ "}.fa-bullhorn:before{content:"ļ‚”"}.fa-bell:before{content:"ļƒ³"}.fa-certificate:before{content:"ļ‚£"}.fa-hand-o-right:before{content:"ļ‚¤"}.fa-hand-o-left:before{content:"ļ‚„"}.fa-hand-o-up:before{content:"ļ‚¦"}.fa-hand-o-down:before{content:"ļ‚§"}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:"ļ‚Ø"}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:"ļ‚©"}.fa-arrow-circle-up:before{content:"ļ‚Ŗ"}.fa-arrow-circle-down:before{content:"ļ‚«"}.fa-globe:before{content:"ļ‚¬"}.fa-wrench:before{content:"ļ‚­"}.fa-tasks:before{content:"ļ‚®"}.fa-filter:before{content:"ļ‚°"}.fa-briefcase:before{content:"ļ‚±"}.fa-arrows-alt:before{content:"ļ‚²"}.fa-group:before,.fa-users:before{content:"ļƒ€"}.fa-chain:before,.fa-link:before,.icon-link:before{content:"ļƒ"}.fa-cloud:before{content:"ļƒ‚"}.fa-flask:before{content:"ļƒƒ"}.fa-cut:before,.fa-scissors:before{content:"ļƒ„"}.fa-copy:before,.fa-files-o:before{content:"ļƒ…"}.fa-paperclip:before{content:"ļƒ†"}.fa-floppy-o:before,.fa-save:before{content:"ļƒ‡"}.fa-square:before{content:"ļƒˆ"}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:"ļƒ‰"}.fa-list-ul:before{content:"ļƒŠ"}.fa-list-ol:before{content:"ļƒ‹"}.fa-strikethrough:before{content:"ļƒŒ"}.fa-underline:before{content:"ļƒ"}.fa-table:before{content:"ļƒŽ"}.fa-magic:before{content:"ļƒ"}.fa-truck:before{content:"ļƒ‘"}.fa-pinterest:before{content:"ļƒ’"}.fa-pinterest-square:before{content:"ļƒ“"}.fa-google-plus-square:before{content:"ļƒ”"}.fa-google-plus:before{content:"ļƒ•"}.fa-money:before{content:"ļƒ–"}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:"ļƒ—"}.fa-caret-up:before{content:"ļƒ˜"}.fa-caret-left:before{content:"ļƒ™"}.fa-caret-right:before{content:"ļƒš"}.fa-columns:before{content:"ļƒ›"}.fa-sort:before,.fa-unsorted:before{content:"ļƒœ"}.fa-sort-desc:before,.fa-sort-down:before{content:"ļƒ"}.fa-sort-asc:before,.fa-sort-up:before{content:"ļƒž"}.fa-envelope:before{content:"ļƒ "}.fa-linkedin:before{content:"ļƒ”"}.fa-rotate-left:before,.fa-undo:before{content:"ļƒ¢"}.fa-gavel:before,.fa-legal:before{content:"ļƒ£"}.fa-dashboard:before,.fa-tachometer:before{content:"ļƒ¤"}.fa-comment-o:before{content:"ļƒ„"}.fa-comments-o:before{content:"ļƒ¦"}.fa-bolt:before,.fa-flash:before{content:"ļƒ§"}.fa-sitemap:before{content:"ļƒØ"}.fa-umbrella:before{content:"ļƒ©"}.fa-clipboard:before,.fa-paste:before{content:"ļƒŖ"}.fa-lightbulb-o:before{content:"ļƒ«"}.fa-exchange:before{content:"ļƒ¬"}.fa-cloud-download:before{content:"ļƒ­"}.fa-cloud-upload:before{content:"ļƒ®"}.fa-user-md:before{content:"ļƒ°"}.fa-stethoscope:before{content:"ļƒ±"}.fa-suitcase:before{content:"ļƒ²"}.fa-bell-o:before{content:"ļ‚¢"}.fa-coffee:before{content:"ļƒ“"}.fa-cutlery:before{content:"ļƒµ"}.fa-file-text-o:before{content:"ļƒ¶"}.fa-building-o:before{content:"ļƒ·"}.fa-hospital-o:before{content:"ļƒø"}.fa-ambulance:before{content:"ļƒ¹"}.fa-medkit:before{content:"ļƒŗ"}.fa-fighter-jet:before{content:"ļƒ»"}.fa-beer:before{content:"ļƒ¼"}.fa-h-square:before{content:"ļƒ½"}.fa-plus-square:before{content:"ļƒ¾"}.fa-angle-double-left:before{content:"ļ„€"}.fa-angle-double-right:before{content:"ļ„"}.fa-angle-double-up:before{content:"ļ„‚"}.fa-angle-double-down:before{content:"ļ„ƒ"}.fa-angle-left:before{content:"ļ„„"}.fa-angle-right:before{content:"ļ„…"}.fa-angle-up:before{content:"ļ„†"}.fa-angle-down:before{content:"ļ„‡"}.fa-desktop:before{content:"ļ„ˆ"}.fa-laptop:before{content:"ļ„‰"}.fa-tablet:before{content:"ļ„Š"}.fa-mobile-phone:before,.fa-mobile:before{content:"ļ„‹"}.fa-circle-o:before{content:"ļ„Œ"}.fa-quote-left:before{content:"ļ„"}.fa-quote-right:before{content:"ļ„Ž"}.fa-spinner:before{content:"ļ„"}.fa-circle:before{content:"ļ„‘"}.fa-mail-reply:before,.fa-reply:before{content:"ļ„’"}.fa-github-alt:before{content:"ļ„“"}.fa-folder-o:before{content:"ļ„”"}.fa-folder-open-o:before{content:"ļ„•"}.fa-smile-o:before{content:"ļ„˜"}.fa-frown-o:before{content:"ļ„™"}.fa-meh-o:before{content:"ļ„š"}.fa-gamepad:before{content:"ļ„›"}.fa-keyboard-o:before{content:"ļ„œ"}.fa-flag-o:before{content:"ļ„"}.fa-flag-checkered:before{content:"ļ„ž"}.fa-terminal:before{content:"ļ„ "}.fa-code:before{content:"ļ„”"}.fa-mail-reply-all:before,.fa-reply-all:before{content:"ļ„¢"}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:"ļ„£"}.fa-location-arrow:before{content:"ļ„¤"}.fa-crop:before{content:"ļ„„"}.fa-code-fork:before{content:"ļ„¦"}.fa-chain-broken:before,.fa-unlink:before{content:"ļ„§"}.fa-question:before{content:"ļ„Ø"}.fa-info:before{content:"ļ„©"}.fa-exclamation:before{content:"ļ„Ŗ"}.fa-superscript:before{content:"ļ„«"}.fa-subscript:before{content:"ļ„¬"}.fa-eraser:before{content:"ļ„­"}.fa-puzzle-piece:before{content:"ļ„®"}.fa-microphone:before{content:"ļ„°"}.fa-microphone-slash:before{content:"ļ„±"}.fa-shield:before{content:"ļ„²"}.fa-calendar-o:before{content:"ļ„³"}.fa-fire-extinguisher:before{content:"ļ„“"}.fa-rocket:before{content:"ļ„µ"}.fa-maxcdn:before{content:"ļ„¶"}.fa-chevron-circle-left:before{content:"ļ„·"}.fa-chevron-circle-right:before{content:"ļ„ø"}.fa-chevron-circle-up:before{content:"ļ„¹"}.fa-chevron-circle-down:before{content:"ļ„ŗ"}.fa-html5:before{content:"ļ„»"}.fa-css3:before{content:"ļ„¼"}.fa-anchor:before{content:"ļ„½"}.fa-unlock-alt:before{content:"ļ„¾"}.fa-bullseye:before{content:"ļ…€"}.fa-ellipsis-h:before{content:"ļ…"}.fa-ellipsis-v:before{content:"ļ…‚"}.fa-rss-square:before{content:"ļ…ƒ"}.fa-play-circle:before{content:"ļ…„"}.fa-ticket:before{content:"ļ……"}.fa-minus-square:before{content:"ļ…†"}.fa-minus-square-o:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before{content:"ļ…‡"}.fa-level-up:before{content:"ļ…ˆ"}.fa-level-down:before{content:"ļ…‰"}.fa-check-square:before{content:"ļ…Š"}.fa-pencil-square:before{content:"ļ…‹"}.fa-external-link-square:before{content:"ļ…Œ"}.fa-share-square:before{content:"ļ…"}.fa-compass:before{content:"ļ…Ž"}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:"ļ…"}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:"ļ…‘"}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:"ļ…’"}.fa-eur:before,.fa-euro:before{content:"ļ…“"}.fa-gbp:before{content:"ļ…”"}.fa-dollar:before,.fa-usd:before{content:"ļ…•"}.fa-inr:before,.fa-rupee:before{content:"ļ…–"}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:"ļ…—"}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:"ļ…˜"}.fa-krw:before,.fa-won:before{content:"ļ…™"}.fa-bitcoin:before,.fa-btc:before{content:"ļ…š"}.fa-file:before{content:"ļ…›"}.fa-file-text:before{content:"ļ…œ"}.fa-sort-alpha-asc:before{content:"ļ…"}.fa-sort-alpha-desc:before{content:"ļ…ž"}.fa-sort-amount-asc:before{content:"ļ… "}.fa-sort-amount-desc:before{content:"ļ…”"}.fa-sort-numeric-asc:before{content:"ļ…¢"}.fa-sort-numeric-desc:before{content:"ļ…£"}.fa-thumbs-up:before{content:"ļ…¤"}.fa-thumbs-down:before{content:"ļ…„"}.fa-youtube-square:before{content:"ļ…¦"}.fa-youtube:before{content:"ļ…§"}.fa-xing:before{content:"ļ…Ø"}.fa-xing-square:before{content:"ļ…©"}.fa-youtube-play:before{content:"ļ…Ŗ"}.fa-dropbox:before{content:"ļ…«"}.fa-stack-overflow:before{content:"ļ…¬"}.fa-instagram:before{content:"ļ…­"}.fa-flickr:before{content:"ļ…®"}.fa-adn:before{content:"ļ…°"}.fa-bitbucket:before,.icon-bitbucket:before{content:"ļ…±"}.fa-bitbucket-square:before{content:"ļ…²"}.fa-tumblr:before{content:"ļ…³"}.fa-tumblr-square:before{content:"ļ…“"}.fa-long-arrow-down:before{content:"ļ…µ"}.fa-long-arrow-up:before{content:"ļ…¶"}.fa-long-arrow-left:before{content:"ļ…·"}.fa-long-arrow-right:before{content:"ļ…ø"}.fa-apple:before{content:"ļ…¹"}.fa-windows:before{content:"ļ…ŗ"}.fa-android:before{content:"ļ…»"}.fa-linux:before{content:"ļ…¼"}.fa-dribbble:before{content:"ļ…½"}.fa-skype:before{content:"ļ…¾"}.fa-foursquare:before{content:"ļ†€"}.fa-trello:before{content:"ļ†"}.fa-female:before{content:"ļ†‚"}.fa-male:before{content:"ļ†ƒ"}.fa-gittip:before,.fa-gratipay:before{content:"ļ†„"}.fa-sun-o:before{content:"ļ†…"}.fa-moon-o:before{content:"ļ††"}.fa-archive:before{content:"ļ†‡"}.fa-bug:before{content:"ļ†ˆ"}.fa-vk:before{content:"ļ†‰"}.fa-weibo:before{content:"ļ†Š"}.fa-renren:before{content:"ļ†‹"}.fa-pagelines:before{content:"ļ†Œ"}.fa-stack-exchange:before{content:"ļ†"}.fa-arrow-circle-o-right:before{content:"ļ†Ž"}.fa-arrow-circle-o-left:before{content:"ļ†"}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:"ļ†‘"}.fa-dot-circle-o:before{content:"ļ†’"}.fa-wheelchair:before{content:"ļ†“"}.fa-vimeo-square:before{content:"ļ†”"}.fa-try:before,.fa-turkish-lira:before{content:"ļ†•"}.fa-plus-square-o:before,.wy-menu-vertical li span.toctree-expand:before{content:"ļ†–"}.fa-space-shuttle:before{content:"ļ†—"}.fa-slack:before{content:"ļ†˜"}.fa-envelope-square:before{content:"ļ†™"}.fa-wordpress:before{content:"ļ†š"}.fa-openid:before{content:"ļ†›"}.fa-bank:before,.fa-institution:before,.fa-university:before{content:"ļ†œ"}.fa-graduation-cap:before,.fa-mortar-board:before{content:"ļ†"}.fa-yahoo:before{content:"ļ†ž"}.fa-google:before{content:"ļ† "}.fa-reddit:before{content:"ļ†”"}.fa-reddit-square:before{content:"ļ†¢"}.fa-stumbleupon-circle:before{content:"ļ†£"}.fa-stumbleupon:before{content:"ļ†¤"}.fa-delicious:before{content:"ļ†„"}.fa-digg:before{content:"ļ†¦"}.fa-pied-piper-pp:before{content:"ļ†§"}.fa-pied-piper-alt:before{content:"ļ†Ø"}.fa-drupal:before{content:"ļ†©"}.fa-joomla:before{content:"ļ†Ŗ"}.fa-language:before{content:"ļ†«"}.fa-fax:before{content:"ļ†¬"}.fa-building:before{content:"ļ†­"}.fa-child:before{content:"ļ†®"}.fa-paw:before{content:"ļ†°"}.fa-spoon:before{content:"ļ†±"}.fa-cube:before{content:"ļ†²"}.fa-cubes:before{content:"ļ†³"}.fa-behance:before{content:"ļ†“"}.fa-behance-square:before{content:"ļ†µ"}.fa-steam:before{content:"ļ†¶"}.fa-steam-square:before{content:"ļ†·"}.fa-recycle:before{content:"ļ†ø"}.fa-automobile:before,.fa-car:before{content:"ļ†¹"}.fa-cab:before,.fa-taxi:before{content:"ļ†ŗ"}.fa-tree:before{content:"ļ†»"}.fa-spotify:before{content:"ļ†¼"}.fa-deviantart:before{content:"ļ†½"}.fa-soundcloud:before{content:"ļ†¾"}.fa-database:before{content:"ļ‡€"}.fa-file-pdf-o:before{content:"ļ‡"}.fa-file-word-o:before{content:"ļ‡‚"}.fa-file-excel-o:before{content:"ļ‡ƒ"}.fa-file-powerpoint-o:before{content:"ļ‡„"}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:"ļ‡…"}.fa-file-archive-o:before,.fa-file-zip-o:before{content:"ļ‡†"}.fa-file-audio-o:before,.fa-file-sound-o:before{content:"ļ‡‡"}.fa-file-movie-o:before,.fa-file-video-o:before{content:"ļ‡ˆ"}.fa-file-code-o:before{content:"ļ‡‰"}.fa-vine:before{content:"ļ‡Š"}.fa-codepen:before{content:"ļ‡‹"}.fa-jsfiddle:before{content:"ļ‡Œ"}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:"ļ‡"}.fa-circle-o-notch:before{content:"ļ‡Ž"}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:"ļ‡"}.fa-empire:before,.fa-ge:before{content:"ļ‡‘"}.fa-git-square:before{content:"ļ‡’"}.fa-git:before{content:"ļ‡“"}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:"ļ‡”"}.fa-tencent-weibo:before{content:"ļ‡•"}.fa-qq:before{content:"ļ‡–"}.fa-wechat:before,.fa-weixin:before{content:"ļ‡—"}.fa-paper-plane:before,.fa-send:before{content:"ļ‡˜"}.fa-paper-plane-o:before,.fa-send-o:before{content:"ļ‡™"}.fa-history:before{content:"ļ‡š"}.fa-circle-thin:before{content:"ļ‡›"}.fa-header:before{content:"ļ‡œ"}.fa-paragraph:before{content:"ļ‡"}.fa-sliders:before{content:"ļ‡ž"}.fa-share-alt:before{content:"ļ‡ "}.fa-share-alt-square:before{content:"ļ‡”"}.fa-bomb:before{content:"ļ‡¢"}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:"ļ‡£"}.fa-tty:before{content:"ļ‡¤"}.fa-binoculars:before{content:"ļ‡„"}.fa-plug:before{content:"ļ‡¦"}.fa-slideshare:before{content:"ļ‡§"}.fa-twitch:before{content:"ļ‡Ø"}.fa-yelp:before{content:"ļ‡©"}.fa-newspaper-o:before{content:"ļ‡Ŗ"}.fa-wifi:before{content:"ļ‡«"}.fa-calculator:before{content:"ļ‡¬"}.fa-paypal:before{content:"ļ‡­"}.fa-google-wallet:before{content:"ļ‡®"}.fa-cc-visa:before{content:"ļ‡°"}.fa-cc-mastercard:before{content:"ļ‡±"}.fa-cc-discover:before{content:"ļ‡²"}.fa-cc-amex:before{content:"ļ‡³"}.fa-cc-paypal:before{content:"ļ‡“"}.fa-cc-stripe:before{content:"ļ‡µ"}.fa-bell-slash:before{content:"ļ‡¶"}.fa-bell-slash-o:before{content:"ļ‡·"}.fa-trash:before{content:"ļ‡ø"}.fa-copyright:before{content:"ļ‡¹"}.fa-at:before{content:"ļ‡ŗ"}.fa-eyedropper:before{content:"ļ‡»"}.fa-paint-brush:before{content:"ļ‡¼"}.fa-birthday-cake:before{content:"ļ‡½"}.fa-area-chart:before{content:"ļ‡¾"}.fa-pie-chart:before{content:"ļˆ€"}.fa-line-chart:before{content:"ļˆ"}.fa-lastfm:before{content:"ļˆ‚"}.fa-lastfm-square:before{content:"ļˆƒ"}.fa-toggle-off:before{content:"ļˆ„"}.fa-toggle-on:before{content:"ļˆ…"}.fa-bicycle:before{content:"ļˆ†"}.fa-bus:before{content:"ļˆ‡"}.fa-ioxhost:before{content:"ļˆˆ"}.fa-angellist:before{content:"ļˆ‰"}.fa-cc:before{content:"ļˆŠ"}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:"ļˆ‹"}.fa-meanpath:before{content:"ļˆŒ"}.fa-buysellads:before{content:"ļˆ"}.fa-connectdevelop:before{content:"ļˆŽ"}.fa-dashcube:before{content:"ļˆ"}.fa-forumbee:before{content:"ļˆ‘"}.fa-leanpub:before{content:"ļˆ’"}.fa-sellsy:before{content:"ļˆ“"}.fa-shirtsinbulk:before{content:"ļˆ”"}.fa-simplybuilt:before{content:"ļˆ•"}.fa-skyatlas:before{content:"ļˆ–"}.fa-cart-plus:before{content:"ļˆ—"}.fa-cart-arrow-down:before{content:"ļˆ˜"}.fa-diamond:before{content:"ļˆ™"}.fa-ship:before{content:"ļˆš"}.fa-user-secret:before{content:"ļˆ›"}.fa-motorcycle:before{content:"ļˆœ"}.fa-street-view:before{content:"ļˆ"}.fa-heartbeat:before{content:"ļˆž"}.fa-venus:before{content:"ļˆ”"}.fa-mars:before{content:"ļˆ¢"}.fa-mercury:before{content:"ļˆ£"}.fa-intersex:before,.fa-transgender:before{content:"ļˆ¤"}.fa-transgender-alt:before{content:"ļˆ„"}.fa-venus-double:before{content:"ļˆ¦"}.fa-mars-double:before{content:"ļˆ§"}.fa-venus-mars:before{content:"ļˆØ"}.fa-mars-stroke:before{content:"ļˆ©"}.fa-mars-stroke-v:before{content:"ļˆŖ"}.fa-mars-stroke-h:before{content:"ļˆ«"}.fa-neuter:before{content:"ļˆ¬"}.fa-genderless:before{content:"ļˆ­"}.fa-facebook-official:before{content:"ļˆ°"}.fa-pinterest-p:before{content:"ļˆ±"}.fa-whatsapp:before{content:"ļˆ²"}.fa-server:before{content:"ļˆ³"}.fa-user-plus:before{content:"ļˆ“"}.fa-user-times:before{content:"ļˆµ"}.fa-bed:before,.fa-hotel:before{content:"ļˆ¶"}.fa-viacoin:before{content:"ļˆ·"}.fa-train:before{content:"ļˆø"}.fa-subway:before{content:"ļˆ¹"}.fa-medium:before{content:"ļˆŗ"}.fa-y-combinator:before,.fa-yc:before{content:"ļˆ»"}.fa-optin-monster:before{content:"ļˆ¼"}.fa-opencart:before{content:"ļˆ½"}.fa-expeditedssl:before{content:"ļˆ¾"}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:"ļ‰€"}.fa-battery-3:before,.fa-battery-three-quarters:before{content:"ļ‰"}.fa-battery-2:before,.fa-battery-half:before{content:"ļ‰‚"}.fa-battery-1:before,.fa-battery-quarter:before{content:"ļ‰ƒ"}.fa-battery-0:before,.fa-battery-empty:before{content:"ļ‰„"}.fa-mouse-pointer:before{content:"ļ‰…"}.fa-i-cursor:before{content:"ļ‰†"}.fa-object-group:before{content:"ļ‰‡"}.fa-object-ungroup:before{content:"ļ‰ˆ"}.fa-sticky-note:before{content:"ļ‰‰"}.fa-sticky-note-o:before{content:"ļ‰Š"}.fa-cc-jcb:before{content:"ļ‰‹"}.fa-cc-diners-club:before{content:"ļ‰Œ"}.fa-clone:before{content:"ļ‰"}.fa-balance-scale:before{content:"ļ‰Ž"}.fa-hourglass-o:before{content:"ļ‰"}.fa-hourglass-1:before,.fa-hourglass-start:before{content:"ļ‰‘"}.fa-hourglass-2:before,.fa-hourglass-half:before{content:"ļ‰’"}.fa-hourglass-3:before,.fa-hourglass-end:before{content:"ļ‰“"}.fa-hourglass:before{content:"ļ‰”"}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:"ļ‰•"}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:"ļ‰–"}.fa-hand-scissors-o:before{content:"ļ‰—"}.fa-hand-lizard-o:before{content:"ļ‰˜"}.fa-hand-spock-o:before{content:"ļ‰™"}.fa-hand-pointer-o:before{content:"ļ‰š"}.fa-hand-peace-o:before{content:"ļ‰›"}.fa-trademark:before{content:"ļ‰œ"}.fa-registered:before{content:"ļ‰"}.fa-creative-commons:before{content:"ļ‰ž"}.fa-gg:before{content:"ļ‰ "}.fa-gg-circle:before{content:"ļ‰”"}.fa-tripadvisor:before{content:"ļ‰¢"}.fa-odnoklassniki:before{content:"ļ‰£"}.fa-odnoklassniki-square:before{content:"ļ‰¤"}.fa-get-pocket:before{content:"ļ‰„"}.fa-wikipedia-w:before{content:"ļ‰¦"}.fa-safari:before{content:"ļ‰§"}.fa-chrome:before{content:"ļ‰Ø"}.fa-firefox:before{content:"ļ‰©"}.fa-opera:before{content:"ļ‰Ŗ"}.fa-internet-explorer:before{content:"ļ‰«"}.fa-television:before,.fa-tv:before{content:"ļ‰¬"}.fa-contao:before{content:"ļ‰­"}.fa-500px:before{content:"ļ‰®"}.fa-amazon:before{content:"ļ‰°"}.fa-calendar-plus-o:before{content:"ļ‰±"}.fa-calendar-minus-o:before{content:"ļ‰²"}.fa-calendar-times-o:before{content:"ļ‰³"}.fa-calendar-check-o:before{content:"ļ‰“"}.fa-industry:before{content:"ļ‰µ"}.fa-map-pin:before{content:"ļ‰¶"}.fa-map-signs:before{content:"ļ‰·"}.fa-map-o:before{content:"ļ‰ø"}.fa-map:before{content:"ļ‰¹"}.fa-commenting:before{content:"ļ‰ŗ"}.fa-commenting-o:before{content:"ļ‰»"}.fa-houzz:before{content:"ļ‰¼"}.fa-vimeo:before{content:"ļ‰½"}.fa-black-tie:before{content:"ļ‰¾"}.fa-fonticons:before{content:"ļŠ€"}.fa-reddit-alien:before{content:"ļŠ"}.fa-edge:before{content:"ļŠ‚"}.fa-credit-card-alt:before{content:"ļŠƒ"}.fa-codiepie:before{content:"ļŠ„"}.fa-modx:before{content:"ļŠ…"}.fa-fort-awesome:before{content:"ļŠ†"}.fa-usb:before{content:"ļŠ‡"}.fa-product-hunt:before{content:"ļŠˆ"}.fa-mixcloud:before{content:"ļŠ‰"}.fa-scribd:before{content:"ļŠŠ"}.fa-pause-circle:before{content:"ļŠ‹"}.fa-pause-circle-o:before{content:"ļŠŒ"}.fa-stop-circle:before{content:"ļŠ"}.fa-stop-circle-o:before{content:"ļŠŽ"}.fa-shopping-bag:before{content:"ļŠ"}.fa-shopping-basket:before{content:"ļŠ‘"}.fa-hashtag:before{content:"ļŠ’"}.fa-bluetooth:before{content:"ļŠ“"}.fa-bluetooth-b:before{content:"ļŠ”"}.fa-percent:before{content:"ļŠ•"}.fa-gitlab:before,.icon-gitlab:before{content:"ļŠ–"}.fa-wpbeginner:before{content:"ļŠ—"}.fa-wpforms:before{content:"ļŠ˜"}.fa-envira:before{content:"ļŠ™"}.fa-universal-access:before{content:"ļŠš"}.fa-wheelchair-alt:before{content:"ļŠ›"}.fa-question-circle-o:before{content:"ļŠœ"}.fa-blind:before{content:"ļŠ"}.fa-audio-description:before{content:"ļŠž"}.fa-volume-control-phone:before{content:"ļŠ "}.fa-braille:before{content:"ļŠ”"}.fa-assistive-listening-systems:before{content:"ļŠ¢"}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:"ļŠ£"}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:"ļŠ¤"}.fa-glide:before{content:"ļŠ„"}.fa-glide-g:before{content:"ļŠ¦"}.fa-sign-language:before,.fa-signing:before{content:"ļŠ§"}.fa-low-vision:before{content:"ļŠØ"}.fa-viadeo:before{content:"ļŠ©"}.fa-viadeo-square:before{content:"ļŠŖ"}.fa-snapchat:before{content:"ļŠ«"}.fa-snapchat-ghost:before{content:"ļŠ¬"}.fa-snapchat-square:before{content:"ļŠ­"}.fa-pied-piper:before{content:"ļŠ®"}.fa-first-order:before{content:"ļŠ°"}.fa-yoast:before{content:"ļŠ±"}.fa-themeisle:before{content:"ļŠ²"}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:"ļŠ³"}.fa-fa:before,.fa-font-awesome:before{content:"ļŠ“"}.fa-handshake-o:before{content:"ļŠµ"}.fa-envelope-open:before{content:"ļŠ¶"}.fa-envelope-open-o:before{content:"ļŠ·"}.fa-linode:before{content:"ļŠø"}.fa-address-book:before{content:"ļŠ¹"}.fa-address-book-o:before{content:"ļŠŗ"}.fa-address-card:before,.fa-vcard:before{content:"ļŠ»"}.fa-address-card-o:before,.fa-vcard-o:before{content:"ļŠ¼"}.fa-user-circle:before{content:"ļŠ½"}.fa-user-circle-o:before{content:"ļŠ¾"}.fa-user-o:before{content:"ļ‹€"}.fa-id-badge:before{content:"ļ‹"}.fa-drivers-license:before,.fa-id-card:before{content:"ļ‹‚"}.fa-drivers-license-o:before,.fa-id-card-o:before{content:"ļ‹ƒ"}.fa-quora:before{content:"ļ‹„"}.fa-free-code-camp:before{content:"ļ‹…"}.fa-telegram:before{content:"ļ‹†"}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:"ļ‹‡"}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:"ļ‹ˆ"}.fa-thermometer-2:before,.fa-thermometer-half:before{content:"ļ‹‰"}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:"ļ‹Š"}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:"ļ‹‹"}.fa-shower:before{content:"ļ‹Œ"}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:"ļ‹"}.fa-podcast:before{content:"ļ‹Ž"}.fa-window-maximize:before{content:"ļ‹"}.fa-window-minimize:before{content:"ļ‹‘"}.fa-window-restore:before{content:"ļ‹’"}.fa-times-rectangle:before,.fa-window-close:before{content:"ļ‹“"}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:"ļ‹”"}.fa-bandcamp:before{content:"ļ‹•"}.fa-grav:before{content:"ļ‹–"}.fa-etsy:before{content:"ļ‹—"}.fa-imdb:before{content:"ļ‹˜"}.fa-ravelry:before{content:"ļ‹™"}.fa-eercast:before{content:"ļ‹š"}.fa-microchip:before{content:"ļ‹›"}.fa-snowflake-o:before{content:"ļ‹œ"}.fa-superpowers:before{content:"ļ‹"}.fa-wpexplorer:before{content:"ļ‹ž"}.fa-meetup:before{content:"ļ‹ "}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li span.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li span.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li a span.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li span.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p.caption .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a span.toctree-expand,.btn .wy-menu-vertical li.on a span.toctree-expand,.btn .wy-menu-vertical li span.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p.caption .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a span.toctree-expand,.nav .wy-menu-vertical li.on a span.toctree-expand,.nav .wy-menu-vertical li span.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p.caption .btn .headerlink,.rst-content p.caption .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn span.toctree-expand,.wy-menu-vertical li.current>a .btn span.toctree-expand,.wy-menu-vertical li.current>a .nav span.toctree-expand,.wy-menu-vertical li .nav span.toctree-expand,.wy-menu-vertical li.on a .btn span.toctree-expand,.wy-menu-vertical li.on a .nav span.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p.caption .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li span.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p.caption .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li span.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p.caption .btn .fa-large.headerlink,.rst-content p.caption .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn span.fa-large.toctree-expand,.wy-menu-vertical li .nav span.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p.caption .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li span.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p.caption .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li span.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p.caption .btn .fa-spin.headerlink,.rst-content p.caption .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn span.fa-spin.toctree-expand,.wy-menu-vertical li .nav span.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p.caption .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li span.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p.caption .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li span.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p.caption .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li span.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p.caption .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini span.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol li,.rst-content ol.arabic li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content ol.arabic li p:last-child,.rst-content ol.arabic li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.rst-content .wy-breadcrumbs li tt,.wy-breadcrumbs li .rst-content tt,.wy-breadcrumbs li code{padding:5px;border:none;background:none}.rst-content .wy-breadcrumbs li tt.literal,.wy-breadcrumbs li .rst-content tt.literal,.wy-breadcrumbs li code.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li span.toctree-expand{display:block;float:left;margin-left:-1.2em;font-size:.8em;line-height:1.6em;color:#4d4d4d}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover span.toctree-expand,.wy-menu-vertical li.on a:hover span.toctree-expand{color:grey}.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand{display:block;font-size:.8em;line-height:1.6em;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover span.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 span.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 span.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover span.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active span.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p.caption .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p.caption .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content img{max-width:100%;height:auto}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure p.caption{font-style:italic}.rst-content div.figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp{user-select:none;pointer-events:none}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink{visibility:hidden;font-size:14px}.rst-content .code-block-caption .headerlink:after,.rst-content .toctree-wrapper>p.caption .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content p.caption .headerlink:after,.rst-content table>caption .headerlink:after{content:"\f0c1";font-family:FontAwesome}.rst-content .code-block-caption:hover .headerlink:after,.rst-content .toctree-wrapper>p.caption:hover .headerlink:after,.rst-content dl dt:hover .headerlink:after,.rst-content h1:hover .headerlink:after,.rst-content h2:hover .headerlink:after,.rst-content h3:hover .headerlink:after,.rst-content h4:hover .headerlink:after,.rst-content h5:hover .headerlink:after,.rst-content h6:hover .headerlink:after,.rst-content p.caption:hover .headerlink:after,.rst-content table>caption:hover .headerlink:after{visibility:visible}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .hlist{width:100%}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl dt span.classifier:before{content:" : "}html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.field-list>dt:after,html.writer-html5 .rst-content dl.footnote>dt:after{content:":"}html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.footnote>dt>span.brackets{margin-right:.5rem}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{font-style:italic}html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.footnote>dd p,html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{font-size:inherit;line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code,html.writer-html4 .rst-content dl:not(.docutils) tt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/gh-pages/_static/doctools.js b/gh-pages/_static/doctools.js deleted file mode 100644 index daccd20..0000000 --- a/gh-pages/_static/doctools.js +++ /dev/null @@ -1,315 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for all documentation. - * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - */ -jQuery.urldecode = function(x) { - return decodeURIComponent(x).replace(/\+/g, ' '); -}; - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s === 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node, addItems) { - if (node.nodeType === 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && - !jQuery(node.parentNode).hasClass(className) && - !jQuery(node.parentNode).hasClass("nohighlight")) { - var span; - var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.className = className; - } - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - if (isInSVG) { - var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - var bbox = node.parentElement.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute('class', className); - addItems.push({ - "parent": node.parentNode, - "target": rect}); - } - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } - } - var addItems = []; - var result = this.each(function() { - highlight(this, addItems); - }); - for (var i = 0; i < addItems.length; ++i) { - jQuery(addItems[i].parent).before(addItems[i].target); - } - return result; -}; - -/* - * backward compatibility for jQuery.browser - * This will be supported until firefox bug is fixed. - */ -if (!jQuery.browser) { - jQuery.uaMatch = function(ua) { - ua = ua.toLowerCase(); - - var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || - /(webkit)[ \/]([\w.]+)/.exec(ua) || - /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || - /(msie) ([\w.]+)/.exec(ua) || - ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || - []; - - return { - browser: match[ 1 ] || "", - version: match[ 2 ] || "0" - }; - }; - jQuery.browser = {}; - jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; -} - -/** - * Small JavaScript module for the documentation. - */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { - this.initOnKeyListeners(); - } - }, - - /** - * i18n support - */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, - LOCALE : 'unknown', - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated === 'undefined') - return string; - return (typeof translated === 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated === 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; - }, - - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); - }, - - /** - * workaround a firefox stupidity - * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); - }, - - /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - if (!body.length) { - body = $('body'); - } - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('

' + _('Hide Search Matches') + '

') - .appendTo($('#searchbox')); - } - }, - - /** - * init the domain index toggle buttons - */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) === 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); - }, - - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, - - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this === '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); - }, - - initOnKeyListeners: function() { - $(document).keydown(function(event) { - var activeElementType = document.activeElement.tagName; - // don't navigate when in search box or textarea - if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' - && !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) { - switch (event.keyCode) { - case 37: // left - var prevHref = $('link[rel="prev"]').prop('href'); - if (prevHref) { - window.location.href = prevHref; - return false; - } - case 39: // right - var nextHref = $('link[rel="next"]').prop('href'); - if (nextHref) { - window.location.href = nextHref; - return false; - } - } - } - }); - } -}; - -// quick alias for translations -_ = Documentation.gettext; - -$(document).ready(function() { - Documentation.init(); -}); diff --git a/gh-pages/_static/documentation_options.js b/gh-pages/_static/documentation_options.js deleted file mode 100644 index b480793..0000000 --- a/gh-pages/_static/documentation_options.js +++ /dev/null @@ -1,11 +0,0 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '2.3rc1', - LANGUAGE: 'None', - COLLAPSE_INDEX: false, - BUILDER: 'html', - FILE_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false -}; \ No newline at end of file diff --git a/gh-pages/_static/file.png b/gh-pages/_static/file.png deleted file mode 100644 index a858a41..0000000 Binary files a/gh-pages/_static/file.png and /dev/null differ diff --git a/gh-pages/_static/fonts/FontAwesome.otf b/gh-pages/_static/fonts/FontAwesome.otf deleted file mode 100644 index 401ec0f..0000000 Binary files a/gh-pages/_static/fonts/FontAwesome.otf and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-bold.eot b/gh-pages/_static/fonts/Lato/lato-bold.eot deleted file mode 100644 index 3361183..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-bold.eot and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-bold.ttf b/gh-pages/_static/fonts/Lato/lato-bold.ttf deleted file mode 100644 index 29f691d..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-bold.ttf and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-bold.woff b/gh-pages/_static/fonts/Lato/lato-bold.woff deleted file mode 100644 index c6dff51..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-bold.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-bold.woff2 b/gh-pages/_static/fonts/Lato/lato-bold.woff2 deleted file mode 100644 index bb19504..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-bold.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-bolditalic.eot b/gh-pages/_static/fonts/Lato/lato-bolditalic.eot deleted file mode 100644 index 3d41549..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-bolditalic.eot and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-bolditalic.ttf b/gh-pages/_static/fonts/Lato/lato-bolditalic.ttf deleted file mode 100644 index f402040..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-bolditalic.ttf and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-bolditalic.woff b/gh-pages/_static/fonts/Lato/lato-bolditalic.woff deleted file mode 100644 index 88ad05b..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-bolditalic.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-bolditalic.woff2 b/gh-pages/_static/fonts/Lato/lato-bolditalic.woff2 deleted file mode 100644 index c4e3d80..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-bolditalic.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-italic.eot b/gh-pages/_static/fonts/Lato/lato-italic.eot deleted file mode 100644 index 3f82642..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-italic.eot and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-italic.ttf b/gh-pages/_static/fonts/Lato/lato-italic.ttf deleted file mode 100644 index b4bfc9b..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-italic.ttf and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-italic.woff b/gh-pages/_static/fonts/Lato/lato-italic.woff deleted file mode 100644 index 76114bc..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-italic.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-italic.woff2 b/gh-pages/_static/fonts/Lato/lato-italic.woff2 deleted file mode 100644 index 3404f37..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-italic.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-regular.eot b/gh-pages/_static/fonts/Lato/lato-regular.eot deleted file mode 100644 index 11e3f2a..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-regular.eot and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-regular.ttf b/gh-pages/_static/fonts/Lato/lato-regular.ttf deleted file mode 100644 index 74decd9..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-regular.ttf and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-regular.woff b/gh-pages/_static/fonts/Lato/lato-regular.woff deleted file mode 100644 index ae1307f..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-regular.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/Lato/lato-regular.woff2 b/gh-pages/_static/fonts/Lato/lato-regular.woff2 deleted file mode 100644 index 3bf9843..0000000 Binary files a/gh-pages/_static/fonts/Lato/lato-regular.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/Roboto-Slab-Bold.woff b/gh-pages/_static/fonts/Roboto-Slab-Bold.woff deleted file mode 100644 index 6cb6000..0000000 Binary files a/gh-pages/_static/fonts/Roboto-Slab-Bold.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/Roboto-Slab-Bold.woff2 b/gh-pages/_static/fonts/Roboto-Slab-Bold.woff2 deleted file mode 100644 index 7059e23..0000000 Binary files a/gh-pages/_static/fonts/Roboto-Slab-Bold.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/Roboto-Slab-Light.woff b/gh-pages/_static/fonts/Roboto-Slab-Light.woff deleted file mode 100644 index 337d287..0000000 Binary files a/gh-pages/_static/fonts/Roboto-Slab-Light.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/Roboto-Slab-Light.woff2 b/gh-pages/_static/fonts/Roboto-Slab-Light.woff2 deleted file mode 100644 index 20398af..0000000 Binary files a/gh-pages/_static/fonts/Roboto-Slab-Light.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/Roboto-Slab-Regular.woff b/gh-pages/_static/fonts/Roboto-Slab-Regular.woff deleted file mode 100644 index f815f63..0000000 Binary files a/gh-pages/_static/fonts/Roboto-Slab-Regular.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/Roboto-Slab-Regular.woff2 b/gh-pages/_static/fonts/Roboto-Slab-Regular.woff2 deleted file mode 100644 index f2c76e5..0000000 Binary files a/gh-pages/_static/fonts/Roboto-Slab-Regular.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/Roboto-Slab-Thin.woff b/gh-pages/_static/fonts/Roboto-Slab-Thin.woff deleted file mode 100644 index 6b30ea6..0000000 Binary files a/gh-pages/_static/fonts/Roboto-Slab-Thin.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/Roboto-Slab-Thin.woff2 b/gh-pages/_static/fonts/Roboto-Slab-Thin.woff2 deleted file mode 100644 index 328f5bb..0000000 Binary files a/gh-pages/_static/fonts/Roboto-Slab-Thin.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot deleted file mode 100644 index 79dc8ef..0000000 Binary files a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot and /dev/null differ diff --git a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf deleted file mode 100644 index df5d1df..0000000 Binary files a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf and /dev/null differ diff --git a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff deleted file mode 100644 index 6cb6000..0000000 Binary files a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 deleted file mode 100644 index 7059e23..0000000 Binary files a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot deleted file mode 100644 index 2f7ca78..0000000 Binary files a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot and /dev/null differ diff --git a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf deleted file mode 100644 index eb52a79..0000000 Binary files a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf and /dev/null differ diff --git a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff deleted file mode 100644 index f815f63..0000000 Binary files a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 deleted file mode 100644 index f2c76e5..0000000 Binary files a/gh-pages/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/fontawesome-webfont.eot b/gh-pages/_static/fonts/fontawesome-webfont.eot deleted file mode 100644 index e9f60ca..0000000 Binary files a/gh-pages/_static/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/gh-pages/_static/fonts/fontawesome-webfont.svg b/gh-pages/_static/fonts/fontawesome-webfont.svg deleted file mode 100644 index 855c845..0000000 --- a/gh-pages/_static/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,2671 +0,0 @@ - - - - -Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 - By ,,, -Copyright Dave Gandy 2016. All rights reserved. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/gh-pages/_static/fonts/fontawesome-webfont.ttf b/gh-pages/_static/fonts/fontawesome-webfont.ttf deleted file mode 100644 index 35acda2..0000000 Binary files a/gh-pages/_static/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/gh-pages/_static/fonts/fontawesome-webfont.woff b/gh-pages/_static/fonts/fontawesome-webfont.woff deleted file mode 100644 index 400014a..0000000 Binary files a/gh-pages/_static/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/fontawesome-webfont.woff2 b/gh-pages/_static/fonts/fontawesome-webfont.woff2 deleted file mode 100644 index 4d13fc6..0000000 Binary files a/gh-pages/_static/fonts/fontawesome-webfont.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/lato-bold-italic.woff b/gh-pages/_static/fonts/lato-bold-italic.woff deleted file mode 100644 index 88ad05b..0000000 Binary files a/gh-pages/_static/fonts/lato-bold-italic.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/lato-bold-italic.woff2 b/gh-pages/_static/fonts/lato-bold-italic.woff2 deleted file mode 100644 index c4e3d80..0000000 Binary files a/gh-pages/_static/fonts/lato-bold-italic.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/lato-bold.woff b/gh-pages/_static/fonts/lato-bold.woff deleted file mode 100644 index c6dff51..0000000 Binary files a/gh-pages/_static/fonts/lato-bold.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/lato-bold.woff2 b/gh-pages/_static/fonts/lato-bold.woff2 deleted file mode 100644 index bb19504..0000000 Binary files a/gh-pages/_static/fonts/lato-bold.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/lato-normal-italic.woff b/gh-pages/_static/fonts/lato-normal-italic.woff deleted file mode 100644 index 76114bc..0000000 Binary files a/gh-pages/_static/fonts/lato-normal-italic.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/lato-normal-italic.woff2 b/gh-pages/_static/fonts/lato-normal-italic.woff2 deleted file mode 100644 index 3404f37..0000000 Binary files a/gh-pages/_static/fonts/lato-normal-italic.woff2 and /dev/null differ diff --git a/gh-pages/_static/fonts/lato-normal.woff b/gh-pages/_static/fonts/lato-normal.woff deleted file mode 100644 index ae1307f..0000000 Binary files a/gh-pages/_static/fonts/lato-normal.woff and /dev/null differ diff --git a/gh-pages/_static/fonts/lato-normal.woff2 b/gh-pages/_static/fonts/lato-normal.woff2 deleted file mode 100644 index 3bf9843..0000000 Binary files a/gh-pages/_static/fonts/lato-normal.woff2 and /dev/null differ diff --git a/gh-pages/_static/graphviz.css b/gh-pages/_static/graphviz.css deleted file mode 100644 index 8ab69e0..0000000 --- a/gh-pages/_static/graphviz.css +++ /dev/null @@ -1,19 +0,0 @@ -/* - * graphviz.css - * ~~~~~~~~~~~~ - * - * Sphinx stylesheet -- graphviz extension. - * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -img.graphviz { - border: 0; - max-width: 100%; -} - -object.graphviz { - max-width: 100%; -} diff --git a/gh-pages/_static/jquery-3.4.1.js b/gh-pages/_static/jquery-3.4.1.js deleted file mode 100644 index 773ad95..0000000 --- a/gh-pages/_static/jquery-3.4.1.js +++ /dev/null @@ -1,10598 +0,0 @@ -/*! - * jQuery JavaScript Library v3.4.1 - * https://jquery.com/ - * - * Includes Sizzle.js - * https://sizzlejs.com/ - * - * Copyright JS Foundation and other contributors - * Released under the MIT license - * https://jquery.org/license - * - * Date: 2019-05-01T21:04Z - */ -( function( global, factory ) { - - "use strict"; - - if ( typeof module === "object" && typeof module.exports === "object" ) { - - // For CommonJS and CommonJS-like environments where a proper `window` - // is present, execute the factory and get jQuery. - // For environments that do not have a `window` with a `document` - // (such as Node.js), expose a factory as module.exports. - // This accentuates the need for the creation of a real `window`. - // e.g. var jQuery = require("jquery")(window); - // See ticket #14549 for more info. - module.exports = global.document ? - factory( global, true ) : - function( w ) { - if ( !w.document ) { - throw new Error( "jQuery requires a window with a document" ); - } - return factory( w ); - }; - } else { - factory( global ); - } - -// Pass this if window is not defined yet -} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { - -// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 -// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode -// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common -// enough that all such attempts are guarded in a try block. -"use strict"; - -var arr = []; - -var document = window.document; - -var getProto = Object.getPrototypeOf; - -var slice = arr.slice; - -var concat = arr.concat; - -var push = arr.push; - -var indexOf = arr.indexOf; - -var class2type = {}; - -var toString = class2type.toString; - -var hasOwn = class2type.hasOwnProperty; - -var fnToString = hasOwn.toString; - -var ObjectFunctionString = fnToString.call( Object ); - -var support = {}; - -var isFunction = function isFunction( obj ) { - - // Support: Chrome <=57, Firefox <=52 - // In some browsers, typeof returns "function" for HTML elements - // (i.e., `typeof document.createElement( "object" ) === "function"`). - // We don't want to classify *any* DOM node as a function. - return typeof obj === "function" && typeof obj.nodeType !== "number"; - }; - - -var isWindow = function isWindow( obj ) { - return obj != null && obj === obj.window; - }; - - - - - var preservedScriptAttributes = { - type: true, - src: true, - nonce: true, - noModule: true - }; - - function DOMEval( code, node, doc ) { - doc = doc || document; - - var i, val, - script = doc.createElement( "script" ); - - script.text = code; - if ( node ) { - for ( i in preservedScriptAttributes ) { - - // Support: Firefox 64+, Edge 18+ - // Some browsers don't support the "nonce" property on scripts. - // On the other hand, just using `getAttribute` is not enough as - // the `nonce` attribute is reset to an empty string whenever it - // becomes browsing-context connected. - // See https://github.com/whatwg/html/issues/2369 - // See https://html.spec.whatwg.org/#nonce-attributes - // The `node.getAttribute` check was added for the sake of - // `jQuery.globalEval` so that it can fake a nonce-containing node - // via an object. - val = node[ i ] || node.getAttribute && node.getAttribute( i ); - if ( val ) { - script.setAttribute( i, val ); - } - } - } - doc.head.appendChild( script ).parentNode.removeChild( script ); - } - - -function toType( obj ) { - if ( obj == null ) { - return obj + ""; - } - - // Support: Android <=2.3 only (functionish RegExp) - return typeof obj === "object" || typeof obj === "function" ? - class2type[ toString.call( obj ) ] || "object" : - typeof obj; -} -/* global Symbol */ -// Defining this global in .eslintrc.json would create a danger of using the global -// unguarded in another place, it seems safer to define global only for this module - - - -var - version = "3.4.1", - - // Define a local copy of jQuery - jQuery = function( selector, context ) { - - // The jQuery object is actually just the init constructor 'enhanced' - // Need init if jQuery is called (just allow error to be thrown if not included) - return new jQuery.fn.init( selector, context ); - }, - - // Support: Android <=4.0 only - // Make sure we trim BOM and NBSP - rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g; - -jQuery.fn = jQuery.prototype = { - - // The current version of jQuery being used - jquery: version, - - constructor: jQuery, - - // The default length of a jQuery object is 0 - length: 0, - - toArray: function() { - return slice.call( this ); - }, - - // Get the Nth element in the matched element set OR - // Get the whole matched element set as a clean array - get: function( num ) { - - // Return all the elements in a clean array - if ( num == null ) { - return slice.call( this ); - } - - // Return just the one element from the set - return num < 0 ? this[ num + this.length ] : this[ num ]; - }, - - // Take an array of elements and push it onto the stack - // (returning the new matched element set) - pushStack: function( elems ) { - - // Build a new jQuery matched element set - var ret = jQuery.merge( this.constructor(), elems ); - - // Add the old object onto the stack (as a reference) - ret.prevObject = this; - - // Return the newly-formed element set - return ret; - }, - - // Execute a callback for every element in the matched set. - each: function( callback ) { - return jQuery.each( this, callback ); - }, - - map: function( callback ) { - return this.pushStack( jQuery.map( this, function( elem, i ) { - return callback.call( elem, i, elem ); - } ) ); - }, - - slice: function() { - return this.pushStack( slice.apply( this, arguments ) ); - }, - - first: function() { - return this.eq( 0 ); - }, - - last: function() { - return this.eq( -1 ); - }, - - eq: function( i ) { - var len = this.length, - j = +i + ( i < 0 ? len : 0 ); - return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); - }, - - end: function() { - return this.prevObject || this.constructor(); - }, - - // For internal use only. - // Behaves like an Array's method, not like a jQuery method. - push: push, - sort: arr.sort, - splice: arr.splice -}; - -jQuery.extend = jQuery.fn.extend = function() { - var options, name, src, copy, copyIsArray, clone, - target = arguments[ 0 ] || {}, - i = 1, - length = arguments.length, - deep = false; - - // Handle a deep copy situation - if ( typeof target === "boolean" ) { - deep = target; - - // Skip the boolean and the target - target = arguments[ i ] || {}; - i++; - } - - // Handle case when target is a string or something (possible in deep copy) - if ( typeof target !== "object" && !isFunction( target ) ) { - target = {}; - } - - // Extend jQuery itself if only one argument is passed - if ( i === length ) { - target = this; - i--; - } - - for ( ; i < length; i++ ) { - - // Only deal with non-null/undefined values - if ( ( options = arguments[ i ] ) != null ) { - - // Extend the base object - for ( name in options ) { - copy = options[ name ]; - - // Prevent Object.prototype pollution - // Prevent never-ending loop - if ( name === "__proto__" || target === copy ) { - continue; - } - - // Recurse if we're merging plain objects or arrays - if ( deep && copy && ( jQuery.isPlainObject( copy ) || - ( copyIsArray = Array.isArray( copy ) ) ) ) { - src = target[ name ]; - - // Ensure proper type for the source value - if ( copyIsArray && !Array.isArray( src ) ) { - clone = []; - } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { - clone = {}; - } else { - clone = src; - } - copyIsArray = false; - - // Never move original objects, clone them - target[ name ] = jQuery.extend( deep, clone, copy ); - - // Don't bring in undefined values - } else if ( copy !== undefined ) { - target[ name ] = copy; - } - } - } - } - - // Return the modified object - return target; -}; - -jQuery.extend( { - - // Unique for each copy of jQuery on the page - expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), - - // Assume jQuery is ready without the ready module - isReady: true, - - error: function( msg ) { - throw new Error( msg ); - }, - - noop: function() {}, - - isPlainObject: function( obj ) { - var proto, Ctor; - - // Detect obvious negatives - // Use toString instead of jQuery.type to catch host objects - if ( !obj || toString.call( obj ) !== "[object Object]" ) { - return false; - } - - proto = getProto( obj ); - - // Objects with no prototype (e.g., `Object.create( null )`) are plain - if ( !proto ) { - return true; - } - - // Objects with prototype are plain iff they were constructed by a global Object function - Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; - return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; - }, - - isEmptyObject: function( obj ) { - var name; - - for ( name in obj ) { - return false; - } - return true; - }, - - // Evaluates a script in a global context - globalEval: function( code, options ) { - DOMEval( code, { nonce: options && options.nonce } ); - }, - - each: function( obj, callback ) { - var length, i = 0; - - if ( isArrayLike( obj ) ) { - length = obj.length; - for ( ; i < length; i++ ) { - if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { - break; - } - } - } else { - for ( i in obj ) { - if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { - break; - } - } - } - - return obj; - }, - - // Support: Android <=4.0 only - trim: function( text ) { - return text == null ? - "" : - ( text + "" ).replace( rtrim, "" ); - }, - - // results is for internal usage only - makeArray: function( arr, results ) { - var ret = results || []; - - if ( arr != null ) { - if ( isArrayLike( Object( arr ) ) ) { - jQuery.merge( ret, - typeof arr === "string" ? - [ arr ] : arr - ); - } else { - push.call( ret, arr ); - } - } - - return ret; - }, - - inArray: function( elem, arr, i ) { - return arr == null ? -1 : indexOf.call( arr, elem, i ); - }, - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - merge: function( first, second ) { - var len = +second.length, - j = 0, - i = first.length; - - for ( ; j < len; j++ ) { - first[ i++ ] = second[ j ]; - } - - first.length = i; - - return first; - }, - - grep: function( elems, callback, invert ) { - var callbackInverse, - matches = [], - i = 0, - length = elems.length, - callbackExpect = !invert; - - // Go through the array, only saving the items - // that pass the validator function - for ( ; i < length; i++ ) { - callbackInverse = !callback( elems[ i ], i ); - if ( callbackInverse !== callbackExpect ) { - matches.push( elems[ i ] ); - } - } - - return matches; - }, - - // arg is for internal usage only - map: function( elems, callback, arg ) { - var length, value, - i = 0, - ret = []; - - // Go through the array, translating each of the items to their new values - if ( isArrayLike( elems ) ) { - length = elems.length; - for ( ; i < length; i++ ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - - // Go through every key on the object, - } else { - for ( i in elems ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - } - - // Flatten any nested arrays - return concat.apply( [], ret ); - }, - - // A global GUID counter for objects - guid: 1, - - // jQuery.support is not used in Core but other projects attach their - // properties to it so it needs to exist. - support: support -} ); - -if ( typeof Symbol === "function" ) { - jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; -} - -// Populate the class2type map -jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), -function( i, name ) { - class2type[ "[object " + name + "]" ] = name.toLowerCase(); -} ); - -function isArrayLike( obj ) { - - // Support: real iOS 8.2 only (not reproducible in simulator) - // `in` check used to prevent JIT error (gh-2145) - // hasOwn isn't used here due to false negatives - // regarding Nodelist length in IE - var length = !!obj && "length" in obj && obj.length, - type = toType( obj ); - - if ( isFunction( obj ) || isWindow( obj ) ) { - return false; - } - - return type === "array" || length === 0 || - typeof length === "number" && length > 0 && ( length - 1 ) in obj; -} -var Sizzle = -/*! - * Sizzle CSS Selector Engine v2.3.4 - * https://sizzlejs.com/ - * - * Copyright JS Foundation and other contributors - * Released under the MIT license - * https://js.foundation/ - * - * Date: 2019-04-08 - */ -(function( window ) { - -var i, - support, - Expr, - getText, - isXML, - tokenize, - compile, - select, - outermostContext, - sortInput, - hasDuplicate, - - // Local document vars - setDocument, - document, - docElem, - documentIsHTML, - rbuggyQSA, - rbuggyMatches, - matches, - contains, - - // Instance-specific data - expando = "sizzle" + 1 * new Date(), - preferredDoc = window.document, - dirruns = 0, - done = 0, - classCache = createCache(), - tokenCache = createCache(), - compilerCache = createCache(), - nonnativeSelectorCache = createCache(), - sortOrder = function( a, b ) { - if ( a === b ) { - hasDuplicate = true; - } - return 0; - }, - - // Instance methods - hasOwn = ({}).hasOwnProperty, - arr = [], - pop = arr.pop, - push_native = arr.push, - push = arr.push, - slice = arr.slice, - // Use a stripped-down indexOf as it's faster than native - // https://jsperf.com/thor-indexof-vs-for/5 - indexOf = function( list, elem ) { - var i = 0, - len = list.length; - for ( ; i < len; i++ ) { - if ( list[i] === elem ) { - return i; - } - } - return -1; - }, - - booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", - - // Regular expressions - - // http://www.w3.org/TR/css3-selectors/#whitespace - whitespace = "[\\x20\\t\\r\\n\\f]", - - // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier - identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", - - // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors - attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + - // Operator (capture 2) - "*([*^$|!~]?=)" + whitespace + - // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" - "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + - "*\\]", - - pseudos = ":(" + identifier + ")(?:\\((" + - // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: - // 1. quoted (capture 3; capture 4 or capture 5) - "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + - // 2. simple (capture 6) - "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + - // 3. anything else (capture 2) - ".*" + - ")\\)|)", - - // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter - rwhitespace = new RegExp( whitespace + "+", "g" ), - rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), - - rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), - rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), - rdescend = new RegExp( whitespace + "|>" ), - - rpseudo = new RegExp( pseudos ), - ridentifier = new RegExp( "^" + identifier + "$" ), - - matchExpr = { - "ID": new RegExp( "^#(" + identifier + ")" ), - "CLASS": new RegExp( "^\\.(" + identifier + ")" ), - "TAG": new RegExp( "^(" + identifier + "|[*])" ), - "ATTR": new RegExp( "^" + attributes ), - "PSEUDO": new RegExp( "^" + pseudos ), - "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + - "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + - "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), - "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), - // For use in libraries implementing .is() - // We use this for POS matching in `select` - "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + - whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) - }, - - rhtml = /HTML$/i, - rinputs = /^(?:input|select|textarea|button)$/i, - rheader = /^h\d$/i, - - rnative = /^[^{]+\{\s*\[native \w/, - - // Easily-parseable/retrievable ID or TAG or CLASS selectors - rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, - - rsibling = /[+~]/, - - // CSS escapes - // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters - runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), - funescape = function( _, escaped, escapedWhitespace ) { - var high = "0x" + escaped - 0x10000; - // NaN means non-codepoint - // Support: Firefox<24 - // Workaround erroneous numeric interpretation of +"0x" - return high !== high || escapedWhitespace ? - escaped : - high < 0 ? - // BMP codepoint - String.fromCharCode( high + 0x10000 ) : - // Supplemental Plane codepoint (surrogate pair) - String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); - }, - - // CSS string/identifier serialization - // https://drafts.csswg.org/cssom/#common-serializing-idioms - rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, - fcssescape = function( ch, asCodePoint ) { - if ( asCodePoint ) { - - // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER - if ( ch === "\0" ) { - return "\uFFFD"; - } - - // Control characters and (dependent upon position) numbers get escaped as code points - return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; - } - - // Other potentially-special ASCII characters get backslash-escaped - return "\\" + ch; - }, - - // Used for iframes - // See setDocument() - // Removing the function wrapper causes a "Permission Denied" - // error in IE - unloadHandler = function() { - setDocument(); - }, - - inDisabledFieldset = addCombinator( - function( elem ) { - return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; - }, - { dir: "parentNode", next: "legend" } - ); - -// Optimize for push.apply( _, NodeList ) -try { - push.apply( - (arr = slice.call( preferredDoc.childNodes )), - preferredDoc.childNodes - ); - // Support: Android<4.0 - // Detect silently failing push.apply - arr[ preferredDoc.childNodes.length ].nodeType; -} catch ( e ) { - push = { apply: arr.length ? - - // Leverage slice if possible - function( target, els ) { - push_native.apply( target, slice.call(els) ); - } : - - // Support: IE<9 - // Otherwise append directly - function( target, els ) { - var j = target.length, - i = 0; - // Can't trust NodeList.length - while ( (target[j++] = els[i++]) ) {} - target.length = j - 1; - } - }; -} - -function Sizzle( selector, context, results, seed ) { - var m, i, elem, nid, match, groups, newSelector, - newContext = context && context.ownerDocument, - - // nodeType defaults to 9, since context defaults to document - nodeType = context ? context.nodeType : 9; - - results = results || []; - - // Return early from calls with invalid selector or context - if ( typeof selector !== "string" || !selector || - nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { - - return results; - } - - // Try to shortcut find operations (as opposed to filters) in HTML documents - if ( !seed ) { - - if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { - setDocument( context ); - } - context = context || document; - - if ( documentIsHTML ) { - - // If the selector is sufficiently simple, try using a "get*By*" DOM method - // (excepting DocumentFragment context, where the methods don't exist) - if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { - - // ID selector - if ( (m = match[1]) ) { - - // Document context - if ( nodeType === 9 ) { - if ( (elem = context.getElementById( m )) ) { - - // Support: IE, Opera, Webkit - // TODO: identify versions - // getElementById can match elements by name instead of ID - if ( elem.id === m ) { - results.push( elem ); - return results; - } - } else { - return results; - } - - // Element context - } else { - - // Support: IE, Opera, Webkit - // TODO: identify versions - // getElementById can match elements by name instead of ID - if ( newContext && (elem = newContext.getElementById( m )) && - contains( context, elem ) && - elem.id === m ) { - - results.push( elem ); - return results; - } - } - - // Type selector - } else if ( match[2] ) { - push.apply( results, context.getElementsByTagName( selector ) ); - return results; - - // Class selector - } else if ( (m = match[3]) && support.getElementsByClassName && - context.getElementsByClassName ) { - - push.apply( results, context.getElementsByClassName( m ) ); - return results; - } - } - - // Take advantage of querySelectorAll - if ( support.qsa && - !nonnativeSelectorCache[ selector + " " ] && - (!rbuggyQSA || !rbuggyQSA.test( selector )) && - - // Support: IE 8 only - // Exclude object elements - (nodeType !== 1 || context.nodeName.toLowerCase() !== "object") ) { - - newSelector = selector; - newContext = context; - - // qSA considers elements outside a scoping root when evaluating child or - // descendant combinators, which is not what we want. - // In such cases, we work around the behavior by prefixing every selector in the - // list with an ID selector referencing the scope context. - // Thanks to Andrew Dupont for this technique. - if ( nodeType === 1 && rdescend.test( selector ) ) { - - // Capture the context ID, setting it first if necessary - if ( (nid = context.getAttribute( "id" )) ) { - nid = nid.replace( rcssescape, fcssescape ); - } else { - context.setAttribute( "id", (nid = expando) ); - } - - // Prefix every selector in the list - groups = tokenize( selector ); - i = groups.length; - while ( i-- ) { - groups[i] = "#" + nid + " " + toSelector( groups[i] ); - } - newSelector = groups.join( "," ); - - // Expand context for sibling selectors - newContext = rsibling.test( selector ) && testContext( context.parentNode ) || - context; - } - - try { - push.apply( results, - newContext.querySelectorAll( newSelector ) - ); - return results; - } catch ( qsaError ) { - nonnativeSelectorCache( selector, true ); - } finally { - if ( nid === expando ) { - context.removeAttribute( "id" ); - } - } - } - } - } - - // All others - return select( selector.replace( rtrim, "$1" ), context, results, seed ); -} - -/** - * Create key-value caches of limited size - * @returns {function(string, object)} Returns the Object data after storing it on itself with - * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) - * deleting the oldest entry - */ -function createCache() { - var keys = []; - - function cache( key, value ) { - // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) - if ( keys.push( key + " " ) > Expr.cacheLength ) { - // Only keep the most recent entries - delete cache[ keys.shift() ]; - } - return (cache[ key + " " ] = value); - } - return cache; -} - -/** - * Mark a function for special use by Sizzle - * @param {Function} fn The function to mark - */ -function markFunction( fn ) { - fn[ expando ] = true; - return fn; -} - -/** - * Support testing using an element - * @param {Function} fn Passed the created element and returns a boolean result - */ -function assert( fn ) { - var el = document.createElement("fieldset"); - - try { - return !!fn( el ); - } catch (e) { - return false; - } finally { - // Remove from its parent by default - if ( el.parentNode ) { - el.parentNode.removeChild( el ); - } - // release memory in IE - el = null; - } -} - -/** - * Adds the same handler for all of the specified attrs - * @param {String} attrs Pipe-separated list of attributes - * @param {Function} handler The method that will be applied - */ -function addHandle( attrs, handler ) { - var arr = attrs.split("|"), - i = arr.length; - - while ( i-- ) { - Expr.attrHandle[ arr[i] ] = handler; - } -} - -/** - * Checks document order of two siblings - * @param {Element} a - * @param {Element} b - * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b - */ -function siblingCheck( a, b ) { - var cur = b && a, - diff = cur && a.nodeType === 1 && b.nodeType === 1 && - a.sourceIndex - b.sourceIndex; - - // Use IE sourceIndex if available on both nodes - if ( diff ) { - return diff; - } - - // Check if b follows a - if ( cur ) { - while ( (cur = cur.nextSibling) ) { - if ( cur === b ) { - return -1; - } - } - } - - return a ? 1 : -1; -} - -/** - * Returns a function to use in pseudos for input types - * @param {String} type - */ -function createInputPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for buttons - * @param {String} type - */ -function createButtonPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return (name === "input" || name === "button") && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for :enabled/:disabled - * @param {Boolean} disabled true for :disabled; false for :enabled - */ -function createDisabledPseudo( disabled ) { - - // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable - return function( elem ) { - - // Only certain elements can match :enabled or :disabled - // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled - // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled - if ( "form" in elem ) { - - // Check for inherited disabledness on relevant non-disabled elements: - // * listed form-associated elements in a disabled fieldset - // https://html.spec.whatwg.org/multipage/forms.html#category-listed - // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled - // * option elements in a disabled optgroup - // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled - // All such elements have a "form" property. - if ( elem.parentNode && elem.disabled === false ) { - - // Option elements defer to a parent optgroup if present - if ( "label" in elem ) { - if ( "label" in elem.parentNode ) { - return elem.parentNode.disabled === disabled; - } else { - return elem.disabled === disabled; - } - } - - // Support: IE 6 - 11 - // Use the isDisabled shortcut property to check for disabled fieldset ancestors - return elem.isDisabled === disabled || - - // Where there is no isDisabled, check manually - /* jshint -W018 */ - elem.isDisabled !== !disabled && - inDisabledFieldset( elem ) === disabled; - } - - return elem.disabled === disabled; - - // Try to winnow out elements that can't be disabled before trusting the disabled property. - // Some victims get caught in our net (label, legend, menu, track), but it shouldn't - // even exist on them, let alone have a boolean value. - } else if ( "label" in elem ) { - return elem.disabled === disabled; - } - - // Remaining elements are neither :enabled nor :disabled - return false; - }; -} - -/** - * Returns a function to use in pseudos for positionals - * @param {Function} fn - */ -function createPositionalPseudo( fn ) { - return markFunction(function( argument ) { - argument = +argument; - return markFunction(function( seed, matches ) { - var j, - matchIndexes = fn( [], seed.length, argument ), - i = matchIndexes.length; - - // Match elements found at the specified indexes - while ( i-- ) { - if ( seed[ (j = matchIndexes[i]) ] ) { - seed[j] = !(matches[j] = seed[j]); - } - } - }); - }); -} - -/** - * Checks a node for validity as a Sizzle context - * @param {Element|Object=} context - * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value - */ -function testContext( context ) { - return context && typeof context.getElementsByTagName !== "undefined" && context; -} - -// Expose support vars for convenience -support = Sizzle.support = {}; - -/** - * Detects XML nodes - * @param {Element|Object} elem An element or a document - * @returns {Boolean} True iff elem is a non-HTML XML node - */ -isXML = Sizzle.isXML = function( elem ) { - var namespace = elem.namespaceURI, - docElem = (elem.ownerDocument || elem).documentElement; - - // Support: IE <=8 - // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes - // https://bugs.jquery.com/ticket/4833 - return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); -}; - -/** - * Sets document-related variables once based on the current document - * @param {Element|Object} [doc] An element or document object to use to set the document - * @returns {Object} Returns the current document - */ -setDocument = Sizzle.setDocument = function( node ) { - var hasCompare, subWindow, - doc = node ? node.ownerDocument || node : preferredDoc; - - // Return early if doc is invalid or already selected - if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { - return document; - } - - // Update global variables - document = doc; - docElem = document.documentElement; - documentIsHTML = !isXML( document ); - - // Support: IE 9-11, Edge - // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) - if ( preferredDoc !== document && - (subWindow = document.defaultView) && subWindow.top !== subWindow ) { - - // Support: IE 11, Edge - if ( subWindow.addEventListener ) { - subWindow.addEventListener( "unload", unloadHandler, false ); - - // Support: IE 9 - 10 only - } else if ( subWindow.attachEvent ) { - subWindow.attachEvent( "onunload", unloadHandler ); - } - } - - /* Attributes - ---------------------------------------------------------------------- */ - - // Support: IE<8 - // Verify that getAttribute really returns attributes and not properties - // (excepting IE8 booleans) - support.attributes = assert(function( el ) { - el.className = "i"; - return !el.getAttribute("className"); - }); - - /* getElement(s)By* - ---------------------------------------------------------------------- */ - - // Check if getElementsByTagName("*") returns only elements - support.getElementsByTagName = assert(function( el ) { - el.appendChild( document.createComment("") ); - return !el.getElementsByTagName("*").length; - }); - - // Support: IE<9 - support.getElementsByClassName = rnative.test( document.getElementsByClassName ); - - // Support: IE<10 - // Check if getElementById returns elements by name - // The broken getElementById methods don't pick up programmatically-set names, - // so use a roundabout getElementsByName test - support.getById = assert(function( el ) { - docElem.appendChild( el ).id = expando; - return !document.getElementsByName || !document.getElementsByName( expando ).length; - }); - - // ID filter and find - if ( support.getById ) { - Expr.filter["ID"] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - return elem.getAttribute("id") === attrId; - }; - }; - Expr.find["ID"] = function( id, context ) { - if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { - var elem = context.getElementById( id ); - return elem ? [ elem ] : []; - } - }; - } else { - Expr.filter["ID"] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - var node = typeof elem.getAttributeNode !== "undefined" && - elem.getAttributeNode("id"); - return node && node.value === attrId; - }; - }; - - // Support: IE 6 - 7 only - // getElementById is not reliable as a find shortcut - Expr.find["ID"] = function( id, context ) { - if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { - var node, i, elems, - elem = context.getElementById( id ); - - if ( elem ) { - - // Verify the id attribute - node = elem.getAttributeNode("id"); - if ( node && node.value === id ) { - return [ elem ]; - } - - // Fall back on getElementsByName - elems = context.getElementsByName( id ); - i = 0; - while ( (elem = elems[i++]) ) { - node = elem.getAttributeNode("id"); - if ( node && node.value === id ) { - return [ elem ]; - } - } - } - - return []; - } - }; - } - - // Tag - Expr.find["TAG"] = support.getElementsByTagName ? - function( tag, context ) { - if ( typeof context.getElementsByTagName !== "undefined" ) { - return context.getElementsByTagName( tag ); - - // DocumentFragment nodes don't have gEBTN - } else if ( support.qsa ) { - return context.querySelectorAll( tag ); - } - } : - - function( tag, context ) { - var elem, - tmp = [], - i = 0, - // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too - results = context.getElementsByTagName( tag ); - - // Filter out possible comments - if ( tag === "*" ) { - while ( (elem = results[i++]) ) { - if ( elem.nodeType === 1 ) { - tmp.push( elem ); - } - } - - return tmp; - } - return results; - }; - - // Class - Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { - if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { - return context.getElementsByClassName( className ); - } - }; - - /* QSA/matchesSelector - ---------------------------------------------------------------------- */ - - // QSA and matchesSelector support - - // matchesSelector(:active) reports false when true (IE9/Opera 11.5) - rbuggyMatches = []; - - // qSa(:focus) reports false when true (Chrome 21) - // We allow this because of a bug in IE8/9 that throws an error - // whenever `document.activeElement` is accessed on an iframe - // So, we allow :focus to pass through QSA all the time to avoid the IE error - // See https://bugs.jquery.com/ticket/13378 - rbuggyQSA = []; - - if ( (support.qsa = rnative.test( document.querySelectorAll )) ) { - // Build QSA regex - // Regex strategy adopted from Diego Perini - assert(function( el ) { - // Select is set to empty string on purpose - // This is to test IE's treatment of not explicitly - // setting a boolean content attribute, - // since its presence should be enough - // https://bugs.jquery.com/ticket/12359 - docElem.appendChild( el ).innerHTML = "" + - ""; - - // Support: IE8, Opera 11-12.16 - // Nothing should be selected when empty strings follow ^= or $= or *= - // The test attribute must be unknown in Opera but "safe" for WinRT - // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section - if ( el.querySelectorAll("[msallowcapture^='']").length ) { - rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); - } - - // Support: IE8 - // Boolean attributes and "value" are not treated correctly - if ( !el.querySelectorAll("[selected]").length ) { - rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); - } - - // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ - if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { - rbuggyQSA.push("~="); - } - - // Webkit/Opera - :checked should return selected option elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - // IE8 throws error here and will not see later tests - if ( !el.querySelectorAll(":checked").length ) { - rbuggyQSA.push(":checked"); - } - - // Support: Safari 8+, iOS 8+ - // https://bugs.webkit.org/show_bug.cgi?id=136851 - // In-page `selector#id sibling-combinator selector` fails - if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { - rbuggyQSA.push(".#.+[+~]"); - } - }); - - assert(function( el ) { - el.innerHTML = "" + - ""; - - // Support: Windows 8 Native Apps - // The type and name attributes are restricted during .innerHTML assignment - var input = document.createElement("input"); - input.setAttribute( "type", "hidden" ); - el.appendChild( input ).setAttribute( "name", "D" ); - - // Support: IE8 - // Enforce case-sensitivity of name attribute - if ( el.querySelectorAll("[name=d]").length ) { - rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); - } - - // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) - // IE8 throws error here and will not see later tests - if ( el.querySelectorAll(":enabled").length !== 2 ) { - rbuggyQSA.push( ":enabled", ":disabled" ); - } - - // Support: IE9-11+ - // IE's :disabled selector does not pick up the children of disabled fieldsets - docElem.appendChild( el ).disabled = true; - if ( el.querySelectorAll(":disabled").length !== 2 ) { - rbuggyQSA.push( ":enabled", ":disabled" ); - } - - // Opera 10-11 does not throw on post-comma invalid pseudos - el.querySelectorAll("*,:x"); - rbuggyQSA.push(",.*:"); - }); - } - - if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || - docElem.webkitMatchesSelector || - docElem.mozMatchesSelector || - docElem.oMatchesSelector || - docElem.msMatchesSelector) )) ) { - - assert(function( el ) { - // Check to see if it's possible to do matchesSelector - // on a disconnected node (IE 9) - support.disconnectedMatch = matches.call( el, "*" ); - - // This should fail with an exception - // Gecko does not error, returns false instead - matches.call( el, "[s!='']:x" ); - rbuggyMatches.push( "!=", pseudos ); - }); - } - - rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); - rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); - - /* Contains - ---------------------------------------------------------------------- */ - hasCompare = rnative.test( docElem.compareDocumentPosition ); - - // Element contains another - // Purposefully self-exclusive - // As in, an element does not contain itself - contains = hasCompare || rnative.test( docElem.contains ) ? - function( a, b ) { - var adown = a.nodeType === 9 ? a.documentElement : a, - bup = b && b.parentNode; - return a === bup || !!( bup && bup.nodeType === 1 && ( - adown.contains ? - adown.contains( bup ) : - a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 - )); - } : - function( a, b ) { - if ( b ) { - while ( (b = b.parentNode) ) { - if ( b === a ) { - return true; - } - } - } - return false; - }; - - /* Sorting - ---------------------------------------------------------------------- */ - - // Document order sorting - sortOrder = hasCompare ? - function( a, b ) { - - // Flag for duplicate removal - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - // Sort on method existence if only one input has compareDocumentPosition - var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; - if ( compare ) { - return compare; - } - - // Calculate position if both inputs belong to the same document - compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? - a.compareDocumentPosition( b ) : - - // Otherwise we know they are disconnected - 1; - - // Disconnected nodes - if ( compare & 1 || - (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { - - // Choose the first element that is related to our preferred document - if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { - return -1; - } - if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { - return 1; - } - - // Maintain original order - return sortInput ? - ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : - 0; - } - - return compare & 4 ? -1 : 1; - } : - function( a, b ) { - // Exit early if the nodes are identical - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - var cur, - i = 0, - aup = a.parentNode, - bup = b.parentNode, - ap = [ a ], - bp = [ b ]; - - // Parentless nodes are either documents or disconnected - if ( !aup || !bup ) { - return a === document ? -1 : - b === document ? 1 : - aup ? -1 : - bup ? 1 : - sortInput ? - ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : - 0; - - // If the nodes are siblings, we can do a quick check - } else if ( aup === bup ) { - return siblingCheck( a, b ); - } - - // Otherwise we need full lists of their ancestors for comparison - cur = a; - while ( (cur = cur.parentNode) ) { - ap.unshift( cur ); - } - cur = b; - while ( (cur = cur.parentNode) ) { - bp.unshift( cur ); - } - - // Walk down the tree looking for a discrepancy - while ( ap[i] === bp[i] ) { - i++; - } - - return i ? - // Do a sibling check if the nodes have a common ancestor - siblingCheck( ap[i], bp[i] ) : - - // Otherwise nodes in our document sort first - ap[i] === preferredDoc ? -1 : - bp[i] === preferredDoc ? 1 : - 0; - }; - - return document; -}; - -Sizzle.matches = function( expr, elements ) { - return Sizzle( expr, null, null, elements ); -}; - -Sizzle.matchesSelector = function( elem, expr ) { - // Set document vars if needed - if ( ( elem.ownerDocument || elem ) !== document ) { - setDocument( elem ); - } - - if ( support.matchesSelector && documentIsHTML && - !nonnativeSelectorCache[ expr + " " ] && - ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && - ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { - - try { - var ret = matches.call( elem, expr ); - - // IE 9's matchesSelector returns false on disconnected nodes - if ( ret || support.disconnectedMatch || - // As well, disconnected nodes are said to be in a document - // fragment in IE 9 - elem.document && elem.document.nodeType !== 11 ) { - return ret; - } - } catch (e) { - nonnativeSelectorCache( expr, true ); - } - } - - return Sizzle( expr, document, null, [ elem ] ).length > 0; -}; - -Sizzle.contains = function( context, elem ) { - // Set document vars if needed - if ( ( context.ownerDocument || context ) !== document ) { - setDocument( context ); - } - return contains( context, elem ); -}; - -Sizzle.attr = function( elem, name ) { - // Set document vars if needed - if ( ( elem.ownerDocument || elem ) !== document ) { - setDocument( elem ); - } - - var fn = Expr.attrHandle[ name.toLowerCase() ], - // Don't get fooled by Object.prototype properties (jQuery #13807) - val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? - fn( elem, name, !documentIsHTML ) : - undefined; - - return val !== undefined ? - val : - support.attributes || !documentIsHTML ? - elem.getAttribute( name ) : - (val = elem.getAttributeNode(name)) && val.specified ? - val.value : - null; -}; - -Sizzle.escape = function( sel ) { - return (sel + "").replace( rcssescape, fcssescape ); -}; - -Sizzle.error = function( msg ) { - throw new Error( "Syntax error, unrecognized expression: " + msg ); -}; - -/** - * Document sorting and removing duplicates - * @param {ArrayLike} results - */ -Sizzle.uniqueSort = function( results ) { - var elem, - duplicates = [], - j = 0, - i = 0; - - // Unless we *know* we can detect duplicates, assume their presence - hasDuplicate = !support.detectDuplicates; - sortInput = !support.sortStable && results.slice( 0 ); - results.sort( sortOrder ); - - if ( hasDuplicate ) { - while ( (elem = results[i++]) ) { - if ( elem === results[ i ] ) { - j = duplicates.push( i ); - } - } - while ( j-- ) { - results.splice( duplicates[ j ], 1 ); - } - } - - // Clear input after sorting to release objects - // See https://github.com/jquery/sizzle/pull/225 - sortInput = null; - - return results; -}; - -/** - * Utility function for retrieving the text value of an array of DOM nodes - * @param {Array|Element} elem - */ -getText = Sizzle.getText = function( elem ) { - var node, - ret = "", - i = 0, - nodeType = elem.nodeType; - - if ( !nodeType ) { - // If no nodeType, this is expected to be an array - while ( (node = elem[i++]) ) { - // Do not traverse comment nodes - ret += getText( node ); - } - } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { - // Use textContent for elements - // innerText usage removed for consistency of new lines (jQuery #11153) - if ( typeof elem.textContent === "string" ) { - return elem.textContent; - } else { - // Traverse its children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - ret += getText( elem ); - } - } - } else if ( nodeType === 3 || nodeType === 4 ) { - return elem.nodeValue; - } - // Do not include comment or processing instruction nodes - - return ret; -}; - -Expr = Sizzle.selectors = { - - // Can be adjusted by the user - cacheLength: 50, - - createPseudo: markFunction, - - match: matchExpr, - - attrHandle: {}, - - find: {}, - - relative: { - ">": { dir: "parentNode", first: true }, - " ": { dir: "parentNode" }, - "+": { dir: "previousSibling", first: true }, - "~": { dir: "previousSibling" } - }, - - preFilter: { - "ATTR": function( match ) { - match[1] = match[1].replace( runescape, funescape ); - - // Move the given value to match[3] whether quoted or unquoted - match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); - - if ( match[2] === "~=" ) { - match[3] = " " + match[3] + " "; - } - - return match.slice( 0, 4 ); - }, - - "CHILD": function( match ) { - /* matches from matchExpr["CHILD"] - 1 type (only|nth|...) - 2 what (child|of-type) - 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) - 4 xn-component of xn+y argument ([+-]?\d*n|) - 5 sign of xn-component - 6 x of xn-component - 7 sign of y-component - 8 y of y-component - */ - match[1] = match[1].toLowerCase(); - - if ( match[1].slice( 0, 3 ) === "nth" ) { - // nth-* requires argument - if ( !match[3] ) { - Sizzle.error( match[0] ); - } - - // numeric x and y parameters for Expr.filter.CHILD - // remember that false/true cast respectively to 0/1 - match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); - match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); - - // other types prohibit arguments - } else if ( match[3] ) { - Sizzle.error( match[0] ); - } - - return match; - }, - - "PSEUDO": function( match ) { - var excess, - unquoted = !match[6] && match[2]; - - if ( matchExpr["CHILD"].test( match[0] ) ) { - return null; - } - - // Accept quoted arguments as-is - if ( match[3] ) { - match[2] = match[4] || match[5] || ""; - - // Strip excess characters from unquoted arguments - } else if ( unquoted && rpseudo.test( unquoted ) && - // Get excess from tokenize (recursively) - (excess = tokenize( unquoted, true )) && - // advance to the next closing parenthesis - (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { - - // excess is a negative index - match[0] = match[0].slice( 0, excess ); - match[2] = unquoted.slice( 0, excess ); - } - - // Return only captures needed by the pseudo filter method (type and argument) - return match.slice( 0, 3 ); - } - }, - - filter: { - - "TAG": function( nodeNameSelector ) { - var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); - return nodeNameSelector === "*" ? - function() { return true; } : - function( elem ) { - return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; - }; - }, - - "CLASS": function( className ) { - var pattern = classCache[ className + " " ]; - - return pattern || - (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && - classCache( className, function( elem ) { - return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); - }); - }, - - "ATTR": function( name, operator, check ) { - return function( elem ) { - var result = Sizzle.attr( elem, name ); - - if ( result == null ) { - return operator === "!="; - } - if ( !operator ) { - return true; - } - - result += ""; - - return operator === "=" ? result === check : - operator === "!=" ? result !== check : - operator === "^=" ? check && result.indexOf( check ) === 0 : - operator === "*=" ? check && result.indexOf( check ) > -1 : - operator === "$=" ? check && result.slice( -check.length ) === check : - operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : - operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : - false; - }; - }, - - "CHILD": function( type, what, argument, first, last ) { - var simple = type.slice( 0, 3 ) !== "nth", - forward = type.slice( -4 ) !== "last", - ofType = what === "of-type"; - - return first === 1 && last === 0 ? - - // Shortcut for :nth-*(n) - function( elem ) { - return !!elem.parentNode; - } : - - function( elem, context, xml ) { - var cache, uniqueCache, outerCache, node, nodeIndex, start, - dir = simple !== forward ? "nextSibling" : "previousSibling", - parent = elem.parentNode, - name = ofType && elem.nodeName.toLowerCase(), - useCache = !xml && !ofType, - diff = false; - - if ( parent ) { - - // :(first|last|only)-(child|of-type) - if ( simple ) { - while ( dir ) { - node = elem; - while ( (node = node[ dir ]) ) { - if ( ofType ? - node.nodeName.toLowerCase() === name : - node.nodeType === 1 ) { - - return false; - } - } - // Reverse direction for :only-* (if we haven't yet done so) - start = dir = type === "only" && !start && "nextSibling"; - } - return true; - } - - start = [ forward ? parent.firstChild : parent.lastChild ]; - - // non-xml :nth-child(...) stores cache data on `parent` - if ( forward && useCache ) { - - // Seek `elem` from a previously-cached index - - // ...in a gzip-friendly way - node = parent; - outerCache = node[ expando ] || (node[ expando ] = {}); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - (outerCache[ node.uniqueID ] = {}); - - cache = uniqueCache[ type ] || []; - nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; - diff = nodeIndex && cache[ 2 ]; - node = nodeIndex && parent.childNodes[ nodeIndex ]; - - while ( (node = ++nodeIndex && node && node[ dir ] || - - // Fallback to seeking `elem` from the start - (diff = nodeIndex = 0) || start.pop()) ) { - - // When found, cache indexes on `parent` and break - if ( node.nodeType === 1 && ++diff && node === elem ) { - uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; - break; - } - } - - } else { - // Use previously-cached element index if available - if ( useCache ) { - // ...in a gzip-friendly way - node = elem; - outerCache = node[ expando ] || (node[ expando ] = {}); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - (outerCache[ node.uniqueID ] = {}); - - cache = uniqueCache[ type ] || []; - nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; - diff = nodeIndex; - } - - // xml :nth-child(...) - // or :nth-last-child(...) or :nth(-last)?-of-type(...) - if ( diff === false ) { - // Use the same loop as above to seek `elem` from the start - while ( (node = ++nodeIndex && node && node[ dir ] || - (diff = nodeIndex = 0) || start.pop()) ) { - - if ( ( ofType ? - node.nodeName.toLowerCase() === name : - node.nodeType === 1 ) && - ++diff ) { - - // Cache the index of each encountered element - if ( useCache ) { - outerCache = node[ expando ] || (node[ expando ] = {}); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ node.uniqueID ] || - (outerCache[ node.uniqueID ] = {}); - - uniqueCache[ type ] = [ dirruns, diff ]; - } - - if ( node === elem ) { - break; - } - } - } - } - } - - // Incorporate the offset, then check against cycle size - diff -= last; - return diff === first || ( diff % first === 0 && diff / first >= 0 ); - } - }; - }, - - "PSEUDO": function( pseudo, argument ) { - // pseudo-class names are case-insensitive - // http://www.w3.org/TR/selectors/#pseudo-classes - // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters - // Remember that setFilters inherits from pseudos - var args, - fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || - Sizzle.error( "unsupported pseudo: " + pseudo ); - - // The user may use createPseudo to indicate that - // arguments are needed to create the filter function - // just as Sizzle does - if ( fn[ expando ] ) { - return fn( argument ); - } - - // But maintain support for old signatures - if ( fn.length > 1 ) { - args = [ pseudo, pseudo, "", argument ]; - return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? - markFunction(function( seed, matches ) { - var idx, - matched = fn( seed, argument ), - i = matched.length; - while ( i-- ) { - idx = indexOf( seed, matched[i] ); - seed[ idx ] = !( matches[ idx ] = matched[i] ); - } - }) : - function( elem ) { - return fn( elem, 0, args ); - }; - } - - return fn; - } - }, - - pseudos: { - // Potentially complex pseudos - "not": markFunction(function( selector ) { - // Trim the selector passed to compile - // to avoid treating leading and trailing - // spaces as combinators - var input = [], - results = [], - matcher = compile( selector.replace( rtrim, "$1" ) ); - - return matcher[ expando ] ? - markFunction(function( seed, matches, context, xml ) { - var elem, - unmatched = matcher( seed, null, xml, [] ), - i = seed.length; - - // Match elements unmatched by `matcher` - while ( i-- ) { - if ( (elem = unmatched[i]) ) { - seed[i] = !(matches[i] = elem); - } - } - }) : - function( elem, context, xml ) { - input[0] = elem; - matcher( input, null, xml, results ); - // Don't keep the element (issue #299) - input[0] = null; - return !results.pop(); - }; - }), - - "has": markFunction(function( selector ) { - return function( elem ) { - return Sizzle( selector, elem ).length > 0; - }; - }), - - "contains": markFunction(function( text ) { - text = text.replace( runescape, funescape ); - return function( elem ) { - return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; - }; - }), - - // "Whether an element is represented by a :lang() selector - // is based solely on the element's language value - // being equal to the identifier C, - // or beginning with the identifier C immediately followed by "-". - // The matching of C against the element's language value is performed case-insensitively. - // The identifier C does not have to be a valid language name." - // http://www.w3.org/TR/selectors/#lang-pseudo - "lang": markFunction( function( lang ) { - // lang value must be a valid identifier - if ( !ridentifier.test(lang || "") ) { - Sizzle.error( "unsupported lang: " + lang ); - } - lang = lang.replace( runescape, funescape ).toLowerCase(); - return function( elem ) { - var elemLang; - do { - if ( (elemLang = documentIsHTML ? - elem.lang : - elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { - - elemLang = elemLang.toLowerCase(); - return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; - } - } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); - return false; - }; - }), - - // Miscellaneous - "target": function( elem ) { - var hash = window.location && window.location.hash; - return hash && hash.slice( 1 ) === elem.id; - }, - - "root": function( elem ) { - return elem === docElem; - }, - - "focus": function( elem ) { - return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); - }, - - // Boolean properties - "enabled": createDisabledPseudo( false ), - "disabled": createDisabledPseudo( true ), - - "checked": function( elem ) { - // In CSS3, :checked should return both checked and selected elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - var nodeName = elem.nodeName.toLowerCase(); - return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); - }, - - "selected": function( elem ) { - // Accessing this property makes selected-by-default - // options in Safari work properly - if ( elem.parentNode ) { - elem.parentNode.selectedIndex; - } - - return elem.selected === true; - }, - - // Contents - "empty": function( elem ) { - // http://www.w3.org/TR/selectors/#empty-pseudo - // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), - // but not by others (comment: 8; processing instruction: 7; etc.) - // nodeType < 6 works because attributes (2) do not appear as children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - if ( elem.nodeType < 6 ) { - return false; - } - } - return true; - }, - - "parent": function( elem ) { - return !Expr.pseudos["empty"]( elem ); - }, - - // Element/input types - "header": function( elem ) { - return rheader.test( elem.nodeName ); - }, - - "input": function( elem ) { - return rinputs.test( elem.nodeName ); - }, - - "button": function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === "button" || name === "button"; - }, - - "text": function( elem ) { - var attr; - return elem.nodeName.toLowerCase() === "input" && - elem.type === "text" && - - // Support: IE<8 - // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" - ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); - }, - - // Position-in-collection - "first": createPositionalPseudo(function() { - return [ 0 ]; - }), - - "last": createPositionalPseudo(function( matchIndexes, length ) { - return [ length - 1 ]; - }), - - "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { - return [ argument < 0 ? argument + length : argument ]; - }), - - "even": createPositionalPseudo(function( matchIndexes, length ) { - var i = 0; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - }), - - "odd": createPositionalPseudo(function( matchIndexes, length ) { - var i = 1; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - }), - - "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { - var i = argument < 0 ? - argument + length : - argument > length ? - length : - argument; - for ( ; --i >= 0; ) { - matchIndexes.push( i ); - } - return matchIndexes; - }), - - "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { - var i = argument < 0 ? argument + length : argument; - for ( ; ++i < length; ) { - matchIndexes.push( i ); - } - return matchIndexes; - }) - } -}; - -Expr.pseudos["nth"] = Expr.pseudos["eq"]; - -// Add button/input type pseudos -for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { - Expr.pseudos[ i ] = createInputPseudo( i ); -} -for ( i in { submit: true, reset: true } ) { - Expr.pseudos[ i ] = createButtonPseudo( i ); -} - -// Easy API for creating new setFilters -function setFilters() {} -setFilters.prototype = Expr.filters = Expr.pseudos; -Expr.setFilters = new setFilters(); - -tokenize = Sizzle.tokenize = function( selector, parseOnly ) { - var matched, match, tokens, type, - soFar, groups, preFilters, - cached = tokenCache[ selector + " " ]; - - if ( cached ) { - return parseOnly ? 0 : cached.slice( 0 ); - } - - soFar = selector; - groups = []; - preFilters = Expr.preFilter; - - while ( soFar ) { - - // Comma and first run - if ( !matched || (match = rcomma.exec( soFar )) ) { - if ( match ) { - // Don't consume trailing commas as valid - soFar = soFar.slice( match[0].length ) || soFar; - } - groups.push( (tokens = []) ); - } - - matched = false; - - // Combinators - if ( (match = rcombinators.exec( soFar )) ) { - matched = match.shift(); - tokens.push({ - value: matched, - // Cast descendant combinators to space - type: match[0].replace( rtrim, " " ) - }); - soFar = soFar.slice( matched.length ); - } - - // Filters - for ( type in Expr.filter ) { - if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || - (match = preFilters[ type ]( match ))) ) { - matched = match.shift(); - tokens.push({ - value: matched, - type: type, - matches: match - }); - soFar = soFar.slice( matched.length ); - } - } - - if ( !matched ) { - break; - } - } - - // Return the length of the invalid excess - // if we're just parsing - // Otherwise, throw an error or return tokens - return parseOnly ? - soFar.length : - soFar ? - Sizzle.error( selector ) : - // Cache the tokens - tokenCache( selector, groups ).slice( 0 ); -}; - -function toSelector( tokens ) { - var i = 0, - len = tokens.length, - selector = ""; - for ( ; i < len; i++ ) { - selector += tokens[i].value; - } - return selector; -} - -function addCombinator( matcher, combinator, base ) { - var dir = combinator.dir, - skip = combinator.next, - key = skip || dir, - checkNonElements = base && key === "parentNode", - doneName = done++; - - return combinator.first ? - // Check against closest ancestor/preceding element - function( elem, context, xml ) { - while ( (elem = elem[ dir ]) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - return matcher( elem, context, xml ); - } - } - return false; - } : - - // Check against all ancestor/preceding elements - function( elem, context, xml ) { - var oldCache, uniqueCache, outerCache, - newCache = [ dirruns, doneName ]; - - // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching - if ( xml ) { - while ( (elem = elem[ dir ]) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - if ( matcher( elem, context, xml ) ) { - return true; - } - } - } - } else { - while ( (elem = elem[ dir ]) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - outerCache = elem[ expando ] || (elem[ expando ] = {}); - - // Support: IE <9 only - // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {}); - - if ( skip && skip === elem.nodeName.toLowerCase() ) { - elem = elem[ dir ] || elem; - } else if ( (oldCache = uniqueCache[ key ]) && - oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { - - // Assign to newCache so results back-propagate to previous elements - return (newCache[ 2 ] = oldCache[ 2 ]); - } else { - // Reuse newcache so results back-propagate to previous elements - uniqueCache[ key ] = newCache; - - // A match means we're done; a fail means we have to keep checking - if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { - return true; - } - } - } - } - } - return false; - }; -} - -function elementMatcher( matchers ) { - return matchers.length > 1 ? - function( elem, context, xml ) { - var i = matchers.length; - while ( i-- ) { - if ( !matchers[i]( elem, context, xml ) ) { - return false; - } - } - return true; - } : - matchers[0]; -} - -function multipleContexts( selector, contexts, results ) { - var i = 0, - len = contexts.length; - for ( ; i < len; i++ ) { - Sizzle( selector, contexts[i], results ); - } - return results; -} - -function condense( unmatched, map, filter, context, xml ) { - var elem, - newUnmatched = [], - i = 0, - len = unmatched.length, - mapped = map != null; - - for ( ; i < len; i++ ) { - if ( (elem = unmatched[i]) ) { - if ( !filter || filter( elem, context, xml ) ) { - newUnmatched.push( elem ); - if ( mapped ) { - map.push( i ); - } - } - } - } - - return newUnmatched; -} - -function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { - if ( postFilter && !postFilter[ expando ] ) { - postFilter = setMatcher( postFilter ); - } - if ( postFinder && !postFinder[ expando ] ) { - postFinder = setMatcher( postFinder, postSelector ); - } - return markFunction(function( seed, results, context, xml ) { - var temp, i, elem, - preMap = [], - postMap = [], - preexisting = results.length, - - // Get initial elements from seed or context - elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), - - // Prefilter to get matcher input, preserving a map for seed-results synchronization - matcherIn = preFilter && ( seed || !selector ) ? - condense( elems, preMap, preFilter, context, xml ) : - elems, - - matcherOut = matcher ? - // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, - postFinder || ( seed ? preFilter : preexisting || postFilter ) ? - - // ...intermediate processing is necessary - [] : - - // ...otherwise use results directly - results : - matcherIn; - - // Find primary matches - if ( matcher ) { - matcher( matcherIn, matcherOut, context, xml ); - } - - // Apply postFilter - if ( postFilter ) { - temp = condense( matcherOut, postMap ); - postFilter( temp, [], context, xml ); - - // Un-match failing elements by moving them back to matcherIn - i = temp.length; - while ( i-- ) { - if ( (elem = temp[i]) ) { - matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); - } - } - } - - if ( seed ) { - if ( postFinder || preFilter ) { - if ( postFinder ) { - // Get the final matcherOut by condensing this intermediate into postFinder contexts - temp = []; - i = matcherOut.length; - while ( i-- ) { - if ( (elem = matcherOut[i]) ) { - // Restore matcherIn since elem is not yet a final match - temp.push( (matcherIn[i] = elem) ); - } - } - postFinder( null, (matcherOut = []), temp, xml ); - } - - // Move matched elements from seed to results to keep them synchronized - i = matcherOut.length; - while ( i-- ) { - if ( (elem = matcherOut[i]) && - (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { - - seed[temp] = !(results[temp] = elem); - } - } - } - - // Add elements to results, through postFinder if defined - } else { - matcherOut = condense( - matcherOut === results ? - matcherOut.splice( preexisting, matcherOut.length ) : - matcherOut - ); - if ( postFinder ) { - postFinder( null, results, matcherOut, xml ); - } else { - push.apply( results, matcherOut ); - } - } - }); -} - -function matcherFromTokens( tokens ) { - var checkContext, matcher, j, - len = tokens.length, - leadingRelative = Expr.relative[ tokens[0].type ], - implicitRelative = leadingRelative || Expr.relative[" "], - i = leadingRelative ? 1 : 0, - - // The foundational matcher ensures that elements are reachable from top-level context(s) - matchContext = addCombinator( function( elem ) { - return elem === checkContext; - }, implicitRelative, true ), - matchAnyContext = addCombinator( function( elem ) { - return indexOf( checkContext, elem ) > -1; - }, implicitRelative, true ), - matchers = [ function( elem, context, xml ) { - var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( - (checkContext = context).nodeType ? - matchContext( elem, context, xml ) : - matchAnyContext( elem, context, xml ) ); - // Avoid hanging onto element (issue #299) - checkContext = null; - return ret; - } ]; - - for ( ; i < len; i++ ) { - if ( (matcher = Expr.relative[ tokens[i].type ]) ) { - matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; - } else { - matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); - - // Return special upon seeing a positional matcher - if ( matcher[ expando ] ) { - // Find the next relative operator (if any) for proper handling - j = ++i; - for ( ; j < len; j++ ) { - if ( Expr.relative[ tokens[j].type ] ) { - break; - } - } - return setMatcher( - i > 1 && elementMatcher( matchers ), - i > 1 && toSelector( - // If the preceding token was a descendant combinator, insert an implicit any-element `*` - tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) - ).replace( rtrim, "$1" ), - matcher, - i < j && matcherFromTokens( tokens.slice( i, j ) ), - j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), - j < len && toSelector( tokens ) - ); - } - matchers.push( matcher ); - } - } - - return elementMatcher( matchers ); -} - -function matcherFromGroupMatchers( elementMatchers, setMatchers ) { - var bySet = setMatchers.length > 0, - byElement = elementMatchers.length > 0, - superMatcher = function( seed, context, xml, results, outermost ) { - var elem, j, matcher, - matchedCount = 0, - i = "0", - unmatched = seed && [], - setMatched = [], - contextBackup = outermostContext, - // We must always have either seed elements or outermost context - elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), - // Use integer dirruns iff this is the outermost matcher - dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), - len = elems.length; - - if ( outermost ) { - outermostContext = context === document || context || outermost; - } - - // Add elements passing elementMatchers directly to results - // Support: IE<9, Safari - // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id - for ( ; i !== len && (elem = elems[i]) != null; i++ ) { - if ( byElement && elem ) { - j = 0; - if ( !context && elem.ownerDocument !== document ) { - setDocument( elem ); - xml = !documentIsHTML; - } - while ( (matcher = elementMatchers[j++]) ) { - if ( matcher( elem, context || document, xml) ) { - results.push( elem ); - break; - } - } - if ( outermost ) { - dirruns = dirrunsUnique; - } - } - - // Track unmatched elements for set filters - if ( bySet ) { - // They will have gone through all possible matchers - if ( (elem = !matcher && elem) ) { - matchedCount--; - } - - // Lengthen the array for every element, matched or not - if ( seed ) { - unmatched.push( elem ); - } - } - } - - // `i` is now the count of elements visited above, and adding it to `matchedCount` - // makes the latter nonnegative. - matchedCount += i; - - // Apply set filters to unmatched elements - // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` - // equals `i`), unless we didn't visit _any_ elements in the above loop because we have - // no element matchers and no seed. - // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that - // case, which will result in a "00" `matchedCount` that differs from `i` but is also - // numerically zero. - if ( bySet && i !== matchedCount ) { - j = 0; - while ( (matcher = setMatchers[j++]) ) { - matcher( unmatched, setMatched, context, xml ); - } - - if ( seed ) { - // Reintegrate element matches to eliminate the need for sorting - if ( matchedCount > 0 ) { - while ( i-- ) { - if ( !(unmatched[i] || setMatched[i]) ) { - setMatched[i] = pop.call( results ); - } - } - } - - // Discard index placeholder values to get only actual matches - setMatched = condense( setMatched ); - } - - // Add matches to results - push.apply( results, setMatched ); - - // Seedless set matches succeeding multiple successful matchers stipulate sorting - if ( outermost && !seed && setMatched.length > 0 && - ( matchedCount + setMatchers.length ) > 1 ) { - - Sizzle.uniqueSort( results ); - } - } - - // Override manipulation of globals by nested matchers - if ( outermost ) { - dirruns = dirrunsUnique; - outermostContext = contextBackup; - } - - return unmatched; - }; - - return bySet ? - markFunction( superMatcher ) : - superMatcher; -} - -compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { - var i, - setMatchers = [], - elementMatchers = [], - cached = compilerCache[ selector + " " ]; - - if ( !cached ) { - // Generate a function of recursive functions that can be used to check each element - if ( !match ) { - match = tokenize( selector ); - } - i = match.length; - while ( i-- ) { - cached = matcherFromTokens( match[i] ); - if ( cached[ expando ] ) { - setMatchers.push( cached ); - } else { - elementMatchers.push( cached ); - } - } - - // Cache the compiled function - cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); - - // Save selector and tokenization - cached.selector = selector; - } - return cached; -}; - -/** - * A low-level selection function that works with Sizzle's compiled - * selector functions - * @param {String|Function} selector A selector or a pre-compiled - * selector function built with Sizzle.compile - * @param {Element} context - * @param {Array} [results] - * @param {Array} [seed] A set of elements to match against - */ -select = Sizzle.select = function( selector, context, results, seed ) { - var i, tokens, token, type, find, - compiled = typeof selector === "function" && selector, - match = !seed && tokenize( (selector = compiled.selector || selector) ); - - results = results || []; - - // Try to minimize operations if there is only one selector in the list and no seed - // (the latter of which guarantees us context) - if ( match.length === 1 ) { - - // Reduce context if the leading compound selector is an ID - tokens = match[0] = match[0].slice( 0 ); - if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && - context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) { - - context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; - if ( !context ) { - return results; - - // Precompiled matchers will still verify ancestry, so step up a level - } else if ( compiled ) { - context = context.parentNode; - } - - selector = selector.slice( tokens.shift().value.length ); - } - - // Fetch a seed set for right-to-left matching - i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; - while ( i-- ) { - token = tokens[i]; - - // Abort if we hit a combinator - if ( Expr.relative[ (type = token.type) ] ) { - break; - } - if ( (find = Expr.find[ type ]) ) { - // Search, expanding context for leading sibling combinators - if ( (seed = find( - token.matches[0].replace( runescape, funescape ), - rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context - )) ) { - - // If seed is empty or no tokens remain, we can return early - tokens.splice( i, 1 ); - selector = seed.length && toSelector( tokens ); - if ( !selector ) { - push.apply( results, seed ); - return results; - } - - break; - } - } - } - } - - // Compile and execute a filtering function if one is not provided - // Provide `match` to avoid retokenization if we modified the selector above - ( compiled || compile( selector, match ) )( - seed, - context, - !documentIsHTML, - results, - !context || rsibling.test( selector ) && testContext( context.parentNode ) || context - ); - return results; -}; - -// One-time assignments - -// Sort stability -support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; - -// Support: Chrome 14-35+ -// Always assume duplicates if they aren't passed to the comparison function -support.detectDuplicates = !!hasDuplicate; - -// Initialize against the default document -setDocument(); - -// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) -// Detached nodes confoundingly follow *each other* -support.sortDetached = assert(function( el ) { - // Should return 1, but returns 4 (following) - return el.compareDocumentPosition( document.createElement("fieldset") ) & 1; -}); - -// Support: IE<8 -// Prevent attribute/property "interpolation" -// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx -if ( !assert(function( el ) { - el.innerHTML = ""; - return el.firstChild.getAttribute("href") === "#" ; -}) ) { - addHandle( "type|href|height|width", function( elem, name, isXML ) { - if ( !isXML ) { - return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); - } - }); -} - -// Support: IE<9 -// Use defaultValue in place of getAttribute("value") -if ( !support.attributes || !assert(function( el ) { - el.innerHTML = ""; - el.firstChild.setAttribute( "value", "" ); - return el.firstChild.getAttribute( "value" ) === ""; -}) ) { - addHandle( "value", function( elem, name, isXML ) { - if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { - return elem.defaultValue; - } - }); -} - -// Support: IE<9 -// Use getAttributeNode to fetch booleans when getAttribute lies -if ( !assert(function( el ) { - return el.getAttribute("disabled") == null; -}) ) { - addHandle( booleans, function( elem, name, isXML ) { - var val; - if ( !isXML ) { - return elem[ name ] === true ? name.toLowerCase() : - (val = elem.getAttributeNode( name )) && val.specified ? - val.value : - null; - } - }); -} - -return Sizzle; - -})( window ); - - - -jQuery.find = Sizzle; -jQuery.expr = Sizzle.selectors; - -// Deprecated -jQuery.expr[ ":" ] = jQuery.expr.pseudos; -jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; -jQuery.text = Sizzle.getText; -jQuery.isXMLDoc = Sizzle.isXML; -jQuery.contains = Sizzle.contains; -jQuery.escapeSelector = Sizzle.escape; - - - - -var dir = function( elem, dir, until ) { - var matched = [], - truncate = until !== undefined; - - while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { - if ( elem.nodeType === 1 ) { - if ( truncate && jQuery( elem ).is( until ) ) { - break; - } - matched.push( elem ); - } - } - return matched; -}; - - -var siblings = function( n, elem ) { - var matched = []; - - for ( ; n; n = n.nextSibling ) { - if ( n.nodeType === 1 && n !== elem ) { - matched.push( n ); - } - } - - return matched; -}; - - -var rneedsContext = jQuery.expr.match.needsContext; - - - -function nodeName( elem, name ) { - - return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); - -}; -var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); - - - -// Implement the identical functionality for filter and not -function winnow( elements, qualifier, not ) { - if ( isFunction( qualifier ) ) { - return jQuery.grep( elements, function( elem, i ) { - return !!qualifier.call( elem, i, elem ) !== not; - } ); - } - - // Single element - if ( qualifier.nodeType ) { - return jQuery.grep( elements, function( elem ) { - return ( elem === qualifier ) !== not; - } ); - } - - // Arraylike of elements (jQuery, arguments, Array) - if ( typeof qualifier !== "string" ) { - return jQuery.grep( elements, function( elem ) { - return ( indexOf.call( qualifier, elem ) > -1 ) !== not; - } ); - } - - // Filtered directly for both simple and complex selectors - return jQuery.filter( qualifier, elements, not ); -} - -jQuery.filter = function( expr, elems, not ) { - var elem = elems[ 0 ]; - - if ( not ) { - expr = ":not(" + expr + ")"; - } - - if ( elems.length === 1 && elem.nodeType === 1 ) { - return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; - } - - return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { - return elem.nodeType === 1; - } ) ); -}; - -jQuery.fn.extend( { - find: function( selector ) { - var i, ret, - len = this.length, - self = this; - - if ( typeof selector !== "string" ) { - return this.pushStack( jQuery( selector ).filter( function() { - for ( i = 0; i < len; i++ ) { - if ( jQuery.contains( self[ i ], this ) ) { - return true; - } - } - } ) ); - } - - ret = this.pushStack( [] ); - - for ( i = 0; i < len; i++ ) { - jQuery.find( selector, self[ i ], ret ); - } - - return len > 1 ? jQuery.uniqueSort( ret ) : ret; - }, - filter: function( selector ) { - return this.pushStack( winnow( this, selector || [], false ) ); - }, - not: function( selector ) { - return this.pushStack( winnow( this, selector || [], true ) ); - }, - is: function( selector ) { - return !!winnow( - this, - - // If this is a positional/relative selector, check membership in the returned set - // so $("p:first").is("p:last") won't return true for a doc with two "p". - typeof selector === "string" && rneedsContext.test( selector ) ? - jQuery( selector ) : - selector || [], - false - ).length; - } -} ); - - -// Initialize a jQuery object - - -// A central reference to the root jQuery(document) -var rootjQuery, - - // A simple way to check for HTML strings - // Prioritize #id over to avoid XSS via location.hash (#9521) - // Strict HTML recognition (#11290: must start with <) - // Shortcut simple #id case for speed - rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, - - init = jQuery.fn.init = function( selector, context, root ) { - var match, elem; - - // HANDLE: $(""), $(null), $(undefined), $(false) - if ( !selector ) { - return this; - } - - // Method init() accepts an alternate rootjQuery - // so migrate can support jQuery.sub (gh-2101) - root = root || rootjQuery; - - // Handle HTML strings - if ( typeof selector === "string" ) { - if ( selector[ 0 ] === "<" && - selector[ selector.length - 1 ] === ">" && - selector.length >= 3 ) { - - // Assume that strings that start and end with <> are HTML and skip the regex check - match = [ null, selector, null ]; - - } else { - match = rquickExpr.exec( selector ); - } - - // Match html or make sure no context is specified for #id - if ( match && ( match[ 1 ] || !context ) ) { - - // HANDLE: $(html) -> $(array) - if ( match[ 1 ] ) { - context = context instanceof jQuery ? context[ 0 ] : context; - - // Option to run scripts is true for back-compat - // Intentionally let the error be thrown if parseHTML is not present - jQuery.merge( this, jQuery.parseHTML( - match[ 1 ], - context && context.nodeType ? context.ownerDocument || context : document, - true - ) ); - - // HANDLE: $(html, props) - if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { - for ( match in context ) { - - // Properties of context are called as methods if possible - if ( isFunction( this[ match ] ) ) { - this[ match ]( context[ match ] ); - - // ...and otherwise set as attributes - } else { - this.attr( match, context[ match ] ); - } - } - } - - return this; - - // HANDLE: $(#id) - } else { - elem = document.getElementById( match[ 2 ] ); - - if ( elem ) { - - // Inject the element directly into the jQuery object - this[ 0 ] = elem; - this.length = 1; - } - return this; - } - - // HANDLE: $(expr, $(...)) - } else if ( !context || context.jquery ) { - return ( context || root ).find( selector ); - - // HANDLE: $(expr, context) - // (which is just equivalent to: $(context).find(expr) - } else { - return this.constructor( context ).find( selector ); - } - - // HANDLE: $(DOMElement) - } else if ( selector.nodeType ) { - this[ 0 ] = selector; - this.length = 1; - return this; - - // HANDLE: $(function) - // Shortcut for document ready - } else if ( isFunction( selector ) ) { - return root.ready !== undefined ? - root.ready( selector ) : - - // Execute immediately if ready is not present - selector( jQuery ); - } - - return jQuery.makeArray( selector, this ); - }; - -// Give the init function the jQuery prototype for later instantiation -init.prototype = jQuery.fn; - -// Initialize central reference -rootjQuery = jQuery( document ); - - -var rparentsprev = /^(?:parents|prev(?:Until|All))/, - - // Methods guaranteed to produce a unique set when starting from a unique set - guaranteedUnique = { - children: true, - contents: true, - next: true, - prev: true - }; - -jQuery.fn.extend( { - has: function( target ) { - var targets = jQuery( target, this ), - l = targets.length; - - return this.filter( function() { - var i = 0; - for ( ; i < l; i++ ) { - if ( jQuery.contains( this, targets[ i ] ) ) { - return true; - } - } - } ); - }, - - closest: function( selectors, context ) { - var cur, - i = 0, - l = this.length, - matched = [], - targets = typeof selectors !== "string" && jQuery( selectors ); - - // Positional selectors never match, since there's no _selection_ context - if ( !rneedsContext.test( selectors ) ) { - for ( ; i < l; i++ ) { - for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { - - // Always skip document fragments - if ( cur.nodeType < 11 && ( targets ? - targets.index( cur ) > -1 : - - // Don't pass non-elements to Sizzle - cur.nodeType === 1 && - jQuery.find.matchesSelector( cur, selectors ) ) ) { - - matched.push( cur ); - break; - } - } - } - } - - return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); - }, - - // Determine the position of an element within the set - index: function( elem ) { - - // No argument, return index in parent - if ( !elem ) { - return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; - } - - // Index in selector - if ( typeof elem === "string" ) { - return indexOf.call( jQuery( elem ), this[ 0 ] ); - } - - // Locate the position of the desired element - return indexOf.call( this, - - // If it receives a jQuery object, the first element is used - elem.jquery ? elem[ 0 ] : elem - ); - }, - - add: function( selector, context ) { - return this.pushStack( - jQuery.uniqueSort( - jQuery.merge( this.get(), jQuery( selector, context ) ) - ) - ); - }, - - addBack: function( selector ) { - return this.add( selector == null ? - this.prevObject : this.prevObject.filter( selector ) - ); - } -} ); - -function sibling( cur, dir ) { - while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} - return cur; -} - -jQuery.each( { - parent: function( elem ) { - var parent = elem.parentNode; - return parent && parent.nodeType !== 11 ? parent : null; - }, - parents: function( elem ) { - return dir( elem, "parentNode" ); - }, - parentsUntil: function( elem, i, until ) { - return dir( elem, "parentNode", until ); - }, - next: function( elem ) { - return sibling( elem, "nextSibling" ); - }, - prev: function( elem ) { - return sibling( elem, "previousSibling" ); - }, - nextAll: function( elem ) { - return dir( elem, "nextSibling" ); - }, - prevAll: function( elem ) { - return dir( elem, "previousSibling" ); - }, - nextUntil: function( elem, i, until ) { - return dir( elem, "nextSibling", until ); - }, - prevUntil: function( elem, i, until ) { - return dir( elem, "previousSibling", until ); - }, - siblings: function( elem ) { - return siblings( ( elem.parentNode || {} ).firstChild, elem ); - }, - children: function( elem ) { - return siblings( elem.firstChild ); - }, - contents: function( elem ) { - if ( typeof elem.contentDocument !== "undefined" ) { - return elem.contentDocument; - } - - // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only - // Treat the template element as a regular one in browsers that - // don't support it. - if ( nodeName( elem, "template" ) ) { - elem = elem.content || elem; - } - - return jQuery.merge( [], elem.childNodes ); - } -}, function( name, fn ) { - jQuery.fn[ name ] = function( until, selector ) { - var matched = jQuery.map( this, fn, until ); - - if ( name.slice( -5 ) !== "Until" ) { - selector = until; - } - - if ( selector && typeof selector === "string" ) { - matched = jQuery.filter( selector, matched ); - } - - if ( this.length > 1 ) { - - // Remove duplicates - if ( !guaranteedUnique[ name ] ) { - jQuery.uniqueSort( matched ); - } - - // Reverse order for parents* and prev-derivatives - if ( rparentsprev.test( name ) ) { - matched.reverse(); - } - } - - return this.pushStack( matched ); - }; -} ); -var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); - - - -// Convert String-formatted options into Object-formatted ones -function createOptions( options ) { - var object = {}; - jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { - object[ flag ] = true; - } ); - return object; -} - -/* - * Create a callback list using the following parameters: - * - * options: an optional list of space-separated options that will change how - * the callback list behaves or a more traditional option object - * - * By default a callback list will act like an event callback list and can be - * "fired" multiple times. - * - * Possible options: - * - * once: will ensure the callback list can only be fired once (like a Deferred) - * - * memory: will keep track of previous values and will call any callback added - * after the list has been fired right away with the latest "memorized" - * values (like a Deferred) - * - * unique: will ensure a callback can only be added once (no duplicate in the list) - * - * stopOnFalse: interrupt callings when a callback returns false - * - */ -jQuery.Callbacks = function( options ) { - - // Convert options from String-formatted to Object-formatted if needed - // (we check in cache first) - options = typeof options === "string" ? - createOptions( options ) : - jQuery.extend( {}, options ); - - var // Flag to know if list is currently firing - firing, - - // Last fire value for non-forgettable lists - memory, - - // Flag to know if list was already fired - fired, - - // Flag to prevent firing - locked, - - // Actual callback list - list = [], - - // Queue of execution data for repeatable lists - queue = [], - - // Index of currently firing callback (modified by add/remove as needed) - firingIndex = -1, - - // Fire callbacks - fire = function() { - - // Enforce single-firing - locked = locked || options.once; - - // Execute callbacks for all pending executions, - // respecting firingIndex overrides and runtime changes - fired = firing = true; - for ( ; queue.length; firingIndex = -1 ) { - memory = queue.shift(); - while ( ++firingIndex < list.length ) { - - // Run callback and check for early termination - if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && - options.stopOnFalse ) { - - // Jump to end and forget the data so .add doesn't re-fire - firingIndex = list.length; - memory = false; - } - } - } - - // Forget the data if we're done with it - if ( !options.memory ) { - memory = false; - } - - firing = false; - - // Clean up if we're done firing for good - if ( locked ) { - - // Keep an empty list if we have data for future add calls - if ( memory ) { - list = []; - - // Otherwise, this object is spent - } else { - list = ""; - } - } - }, - - // Actual Callbacks object - self = { - - // Add a callback or a collection of callbacks to the list - add: function() { - if ( list ) { - - // If we have memory from a past run, we should fire after adding - if ( memory && !firing ) { - firingIndex = list.length - 1; - queue.push( memory ); - } - - ( function add( args ) { - jQuery.each( args, function( _, arg ) { - if ( isFunction( arg ) ) { - if ( !options.unique || !self.has( arg ) ) { - list.push( arg ); - } - } else if ( arg && arg.length && toType( arg ) !== "string" ) { - - // Inspect recursively - add( arg ); - } - } ); - } )( arguments ); - - if ( memory && !firing ) { - fire(); - } - } - return this; - }, - - // Remove a callback from the list - remove: function() { - jQuery.each( arguments, function( _, arg ) { - var index; - while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { - list.splice( index, 1 ); - - // Handle firing indexes - if ( index <= firingIndex ) { - firingIndex--; - } - } - } ); - return this; - }, - - // Check if a given callback is in the list. - // If no argument is given, return whether or not list has callbacks attached. - has: function( fn ) { - return fn ? - jQuery.inArray( fn, list ) > -1 : - list.length > 0; - }, - - // Remove all callbacks from the list - empty: function() { - if ( list ) { - list = []; - } - return this; - }, - - // Disable .fire and .add - // Abort any current/pending executions - // Clear all callbacks and values - disable: function() { - locked = queue = []; - list = memory = ""; - return this; - }, - disabled: function() { - return !list; - }, - - // Disable .fire - // Also disable .add unless we have memory (since it would have no effect) - // Abort any pending executions - lock: function() { - locked = queue = []; - if ( !memory && !firing ) { - list = memory = ""; - } - return this; - }, - locked: function() { - return !!locked; - }, - - // Call all callbacks with the given context and arguments - fireWith: function( context, args ) { - if ( !locked ) { - args = args || []; - args = [ context, args.slice ? args.slice() : args ]; - queue.push( args ); - if ( !firing ) { - fire(); - } - } - return this; - }, - - // Call all the callbacks with the given arguments - fire: function() { - self.fireWith( this, arguments ); - return this; - }, - - // To know if the callbacks have already been called at least once - fired: function() { - return !!fired; - } - }; - - return self; -}; - - -function Identity( v ) { - return v; -} -function Thrower( ex ) { - throw ex; -} - -function adoptValue( value, resolve, reject, noValue ) { - var method; - - try { - - // Check for promise aspect first to privilege synchronous behavior - if ( value && isFunction( ( method = value.promise ) ) ) { - method.call( value ).done( resolve ).fail( reject ); - - // Other thenables - } else if ( value && isFunction( ( method = value.then ) ) ) { - method.call( value, resolve, reject ); - - // Other non-thenables - } else { - - // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: - // * false: [ value ].slice( 0 ) => resolve( value ) - // * true: [ value ].slice( 1 ) => resolve() - resolve.apply( undefined, [ value ].slice( noValue ) ); - } - - // For Promises/A+, convert exceptions into rejections - // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in - // Deferred#then to conditionally suppress rejection. - } catch ( value ) { - - // Support: Android 4.0 only - // Strict mode functions invoked without .call/.apply get global-object context - reject.apply( undefined, [ value ] ); - } -} - -jQuery.extend( { - - Deferred: function( func ) { - var tuples = [ - - // action, add listener, callbacks, - // ... .then handlers, argument index, [final state] - [ "notify", "progress", jQuery.Callbacks( "memory" ), - jQuery.Callbacks( "memory" ), 2 ], - [ "resolve", "done", jQuery.Callbacks( "once memory" ), - jQuery.Callbacks( "once memory" ), 0, "resolved" ], - [ "reject", "fail", jQuery.Callbacks( "once memory" ), - jQuery.Callbacks( "once memory" ), 1, "rejected" ] - ], - state = "pending", - promise = { - state: function() { - return state; - }, - always: function() { - deferred.done( arguments ).fail( arguments ); - return this; - }, - "catch": function( fn ) { - return promise.then( null, fn ); - }, - - // Keep pipe for back-compat - pipe: function( /* fnDone, fnFail, fnProgress */ ) { - var fns = arguments; - - return jQuery.Deferred( function( newDefer ) { - jQuery.each( tuples, function( i, tuple ) { - - // Map tuples (progress, done, fail) to arguments (done, fail, progress) - var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; - - // deferred.progress(function() { bind to newDefer or newDefer.notify }) - // deferred.done(function() { bind to newDefer or newDefer.resolve }) - // deferred.fail(function() { bind to newDefer or newDefer.reject }) - deferred[ tuple[ 1 ] ]( function() { - var returned = fn && fn.apply( this, arguments ); - if ( returned && isFunction( returned.promise ) ) { - returned.promise() - .progress( newDefer.notify ) - .done( newDefer.resolve ) - .fail( newDefer.reject ); - } else { - newDefer[ tuple[ 0 ] + "With" ]( - this, - fn ? [ returned ] : arguments - ); - } - } ); - } ); - fns = null; - } ).promise(); - }, - then: function( onFulfilled, onRejected, onProgress ) { - var maxDepth = 0; - function resolve( depth, deferred, handler, special ) { - return function() { - var that = this, - args = arguments, - mightThrow = function() { - var returned, then; - - // Support: Promises/A+ section 2.3.3.3.3 - // https://promisesaplus.com/#point-59 - // Ignore double-resolution attempts - if ( depth < maxDepth ) { - return; - } - - returned = handler.apply( that, args ); - - // Support: Promises/A+ section 2.3.1 - // https://promisesaplus.com/#point-48 - if ( returned === deferred.promise() ) { - throw new TypeError( "Thenable self-resolution" ); - } - - // Support: Promises/A+ sections 2.3.3.1, 3.5 - // https://promisesaplus.com/#point-54 - // https://promisesaplus.com/#point-75 - // Retrieve `then` only once - then = returned && - - // Support: Promises/A+ section 2.3.4 - // https://promisesaplus.com/#point-64 - // Only check objects and functions for thenability - ( typeof returned === "object" || - typeof returned === "function" ) && - returned.then; - - // Handle a returned thenable - if ( isFunction( then ) ) { - - // Special processors (notify) just wait for resolution - if ( special ) { - then.call( - returned, - resolve( maxDepth, deferred, Identity, special ), - resolve( maxDepth, deferred, Thrower, special ) - ); - - // Normal processors (resolve) also hook into progress - } else { - - // ...and disregard older resolution values - maxDepth++; - - then.call( - returned, - resolve( maxDepth, deferred, Identity, special ), - resolve( maxDepth, deferred, Thrower, special ), - resolve( maxDepth, deferred, Identity, - deferred.notifyWith ) - ); - } - - // Handle all other returned values - } else { - - // Only substitute handlers pass on context - // and multiple values (non-spec behavior) - if ( handler !== Identity ) { - that = undefined; - args = [ returned ]; - } - - // Process the value(s) - // Default process is resolve - ( special || deferred.resolveWith )( that, args ); - } - }, - - // Only normal processors (resolve) catch and reject exceptions - process = special ? - mightThrow : - function() { - try { - mightThrow(); - } catch ( e ) { - - if ( jQuery.Deferred.exceptionHook ) { - jQuery.Deferred.exceptionHook( e, - process.stackTrace ); - } - - // Support: Promises/A+ section 2.3.3.3.4.1 - // https://promisesaplus.com/#point-61 - // Ignore post-resolution exceptions - if ( depth + 1 >= maxDepth ) { - - // Only substitute handlers pass on context - // and multiple values (non-spec behavior) - if ( handler !== Thrower ) { - that = undefined; - args = [ e ]; - } - - deferred.rejectWith( that, args ); - } - } - }; - - // Support: Promises/A+ section 2.3.3.3.1 - // https://promisesaplus.com/#point-57 - // Re-resolve promises immediately to dodge false rejection from - // subsequent errors - if ( depth ) { - process(); - } else { - - // Call an optional hook to record the stack, in case of exception - // since it's otherwise lost when execution goes async - if ( jQuery.Deferred.getStackHook ) { - process.stackTrace = jQuery.Deferred.getStackHook(); - } - window.setTimeout( process ); - } - }; - } - - return jQuery.Deferred( function( newDefer ) { - - // progress_handlers.add( ... ) - tuples[ 0 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onProgress ) ? - onProgress : - Identity, - newDefer.notifyWith - ) - ); - - // fulfilled_handlers.add( ... ) - tuples[ 1 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onFulfilled ) ? - onFulfilled : - Identity - ) - ); - - // rejected_handlers.add( ... ) - tuples[ 2 ][ 3 ].add( - resolve( - 0, - newDefer, - isFunction( onRejected ) ? - onRejected : - Thrower - ) - ); - } ).promise(); - }, - - // Get a promise for this deferred - // If obj is provided, the promise aspect is added to the object - promise: function( obj ) { - return obj != null ? jQuery.extend( obj, promise ) : promise; - } - }, - deferred = {}; - - // Add list-specific methods - jQuery.each( tuples, function( i, tuple ) { - var list = tuple[ 2 ], - stateString = tuple[ 5 ]; - - // promise.progress = list.add - // promise.done = list.add - // promise.fail = list.add - promise[ tuple[ 1 ] ] = list.add; - - // Handle state - if ( stateString ) { - list.add( - function() { - - // state = "resolved" (i.e., fulfilled) - // state = "rejected" - state = stateString; - }, - - // rejected_callbacks.disable - // fulfilled_callbacks.disable - tuples[ 3 - i ][ 2 ].disable, - - // rejected_handlers.disable - // fulfilled_handlers.disable - tuples[ 3 - i ][ 3 ].disable, - - // progress_callbacks.lock - tuples[ 0 ][ 2 ].lock, - - // progress_handlers.lock - tuples[ 0 ][ 3 ].lock - ); - } - - // progress_handlers.fire - // fulfilled_handlers.fire - // rejected_handlers.fire - list.add( tuple[ 3 ].fire ); - - // deferred.notify = function() { deferred.notifyWith(...) } - // deferred.resolve = function() { deferred.resolveWith(...) } - // deferred.reject = function() { deferred.rejectWith(...) } - deferred[ tuple[ 0 ] ] = function() { - deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); - return this; - }; - - // deferred.notifyWith = list.fireWith - // deferred.resolveWith = list.fireWith - // deferred.rejectWith = list.fireWith - deferred[ tuple[ 0 ] + "With" ] = list.fireWith; - } ); - - // Make the deferred a promise - promise.promise( deferred ); - - // Call given func if any - if ( func ) { - func.call( deferred, deferred ); - } - - // All done! - return deferred; - }, - - // Deferred helper - when: function( singleValue ) { - var - - // count of uncompleted subordinates - remaining = arguments.length, - - // count of unprocessed arguments - i = remaining, - - // subordinate fulfillment data - resolveContexts = Array( i ), - resolveValues = slice.call( arguments ), - - // the master Deferred - master = jQuery.Deferred(), - - // subordinate callback factory - updateFunc = function( i ) { - return function( value ) { - resolveContexts[ i ] = this; - resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; - if ( !( --remaining ) ) { - master.resolveWith( resolveContexts, resolveValues ); - } - }; - }; - - // Single- and empty arguments are adopted like Promise.resolve - if ( remaining <= 1 ) { - adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, - !remaining ); - - // Use .then() to unwrap secondary thenables (cf. gh-3000) - if ( master.state() === "pending" || - isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { - - return master.then(); - } - } - - // Multiple arguments are aggregated like Promise.all array elements - while ( i-- ) { - adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); - } - - return master.promise(); - } -} ); - - -// These usually indicate a programmer mistake during development, -// warn about them ASAP rather than swallowing them by default. -var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; - -jQuery.Deferred.exceptionHook = function( error, stack ) { - - // Support: IE 8 - 9 only - // Console exists when dev tools are open, which can happen at any time - if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { - window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); - } -}; - - - - -jQuery.readyException = function( error ) { - window.setTimeout( function() { - throw error; - } ); -}; - - - - -// The deferred used on DOM ready -var readyList = jQuery.Deferred(); - -jQuery.fn.ready = function( fn ) { - - readyList - .then( fn ) - - // Wrap jQuery.readyException in a function so that the lookup - // happens at the time of error handling instead of callback - // registration. - .catch( function( error ) { - jQuery.readyException( error ); - } ); - - return this; -}; - -jQuery.extend( { - - // Is the DOM ready to be used? Set to true once it occurs. - isReady: false, - - // A counter to track how many items to wait for before - // the ready event fires. See #6781 - readyWait: 1, - - // Handle when the DOM is ready - ready: function( wait ) { - - // Abort if there are pending holds or we're already ready - if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { - return; - } - - // Remember that the DOM is ready - jQuery.isReady = true; - - // If a normal DOM Ready event fired, decrement, and wait if need be - if ( wait !== true && --jQuery.readyWait > 0 ) { - return; - } - - // If there are functions bound, to execute - readyList.resolveWith( document, [ jQuery ] ); - } -} ); - -jQuery.ready.then = readyList.then; - -// The ready event handler and self cleanup method -function completed() { - document.removeEventListener( "DOMContentLoaded", completed ); - window.removeEventListener( "load", completed ); - jQuery.ready(); -} - -// Catch cases where $(document).ready() is called -// after the browser event has already occurred. -// Support: IE <=9 - 10 only -// Older IE sometimes signals "interactive" too soon -if ( document.readyState === "complete" || - ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { - - // Handle it asynchronously to allow scripts the opportunity to delay ready - window.setTimeout( jQuery.ready ); - -} else { - - // Use the handy event callback - document.addEventListener( "DOMContentLoaded", completed ); - - // A fallback to window.onload, that will always work - window.addEventListener( "load", completed ); -} - - - - -// Multifunctional method to get and set values of a collection -// The value/s can optionally be executed if it's a function -var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { - var i = 0, - len = elems.length, - bulk = key == null; - - // Sets many values - if ( toType( key ) === "object" ) { - chainable = true; - for ( i in key ) { - access( elems, fn, i, key[ i ], true, emptyGet, raw ); - } - - // Sets one value - } else if ( value !== undefined ) { - chainable = true; - - if ( !isFunction( value ) ) { - raw = true; - } - - if ( bulk ) { - - // Bulk operations run against the entire set - if ( raw ) { - fn.call( elems, value ); - fn = null; - - // ...except when executing function values - } else { - bulk = fn; - fn = function( elem, key, value ) { - return bulk.call( jQuery( elem ), value ); - }; - } - } - - if ( fn ) { - for ( ; i < len; i++ ) { - fn( - elems[ i ], key, raw ? - value : - value.call( elems[ i ], i, fn( elems[ i ], key ) ) - ); - } - } - } - - if ( chainable ) { - return elems; - } - - // Gets - if ( bulk ) { - return fn.call( elems ); - } - - return len ? fn( elems[ 0 ], key ) : emptyGet; -}; - - -// Matches dashed string for camelizing -var rmsPrefix = /^-ms-/, - rdashAlpha = /-([a-z])/g; - -// Used by camelCase as callback to replace() -function fcamelCase( all, letter ) { - return letter.toUpperCase(); -} - -// Convert dashed to camelCase; used by the css and data modules -// Support: IE <=9 - 11, Edge 12 - 15 -// Microsoft forgot to hump their vendor prefix (#9572) -function camelCase( string ) { - return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); -} -var acceptData = function( owner ) { - - // Accepts only: - // - Node - // - Node.ELEMENT_NODE - // - Node.DOCUMENT_NODE - // - Object - // - Any - return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); -}; - - - - -function Data() { - this.expando = jQuery.expando + Data.uid++; -} - -Data.uid = 1; - -Data.prototype = { - - cache: function( owner ) { - - // Check if the owner object already has a cache - var value = owner[ this.expando ]; - - // If not, create one - if ( !value ) { - value = {}; - - // We can accept data for non-element nodes in modern browsers, - // but we should not, see #8335. - // Always return an empty object. - if ( acceptData( owner ) ) { - - // If it is a node unlikely to be stringify-ed or looped over - // use plain assignment - if ( owner.nodeType ) { - owner[ this.expando ] = value; - - // Otherwise secure it in a non-enumerable property - // configurable must be true to allow the property to be - // deleted when data is removed - } else { - Object.defineProperty( owner, this.expando, { - value: value, - configurable: true - } ); - } - } - } - - return value; - }, - set: function( owner, data, value ) { - var prop, - cache = this.cache( owner ); - - // Handle: [ owner, key, value ] args - // Always use camelCase key (gh-2257) - if ( typeof data === "string" ) { - cache[ camelCase( data ) ] = value; - - // Handle: [ owner, { properties } ] args - } else { - - // Copy the properties one-by-one to the cache object - for ( prop in data ) { - cache[ camelCase( prop ) ] = data[ prop ]; - } - } - return cache; - }, - get: function( owner, key ) { - return key === undefined ? - this.cache( owner ) : - - // Always use camelCase key (gh-2257) - owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; - }, - access: function( owner, key, value ) { - - // In cases where either: - // - // 1. No key was specified - // 2. A string key was specified, but no value provided - // - // Take the "read" path and allow the get method to determine - // which value to return, respectively either: - // - // 1. The entire cache object - // 2. The data stored at the key - // - if ( key === undefined || - ( ( key && typeof key === "string" ) && value === undefined ) ) { - - return this.get( owner, key ); - } - - // When the key is not a string, or both a key and value - // are specified, set or extend (existing objects) with either: - // - // 1. An object of properties - // 2. A key and value - // - this.set( owner, key, value ); - - // Since the "set" path can have two possible entry points - // return the expected data based on which path was taken[*] - return value !== undefined ? value : key; - }, - remove: function( owner, key ) { - var i, - cache = owner[ this.expando ]; - - if ( cache === undefined ) { - return; - } - - if ( key !== undefined ) { - - // Support array or space separated string of keys - if ( Array.isArray( key ) ) { - - // If key is an array of keys... - // We always set camelCase keys, so remove that. - key = key.map( camelCase ); - } else { - key = camelCase( key ); - - // If a key with the spaces exists, use it. - // Otherwise, create an array by matching non-whitespace - key = key in cache ? - [ key ] : - ( key.match( rnothtmlwhite ) || [] ); - } - - i = key.length; - - while ( i-- ) { - delete cache[ key[ i ] ]; - } - } - - // Remove the expando if there's no more data - if ( key === undefined || jQuery.isEmptyObject( cache ) ) { - - // Support: Chrome <=35 - 45 - // Webkit & Blink performance suffers when deleting properties - // from DOM nodes, so set to undefined instead - // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) - if ( owner.nodeType ) { - owner[ this.expando ] = undefined; - } else { - delete owner[ this.expando ]; - } - } - }, - hasData: function( owner ) { - var cache = owner[ this.expando ]; - return cache !== undefined && !jQuery.isEmptyObject( cache ); - } -}; -var dataPriv = new Data(); - -var dataUser = new Data(); - - - -// Implementation Summary -// -// 1. Enforce API surface and semantic compatibility with 1.9.x branch -// 2. Improve the module's maintainability by reducing the storage -// paths to a single mechanism. -// 3. Use the same single mechanism to support "private" and "user" data. -// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) -// 5. Avoid exposing implementation details on user objects (eg. expando properties) -// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 - -var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, - rmultiDash = /[A-Z]/g; - -function getData( data ) { - if ( data === "true" ) { - return true; - } - - if ( data === "false" ) { - return false; - } - - if ( data === "null" ) { - return null; - } - - // Only convert to a number if it doesn't change the string - if ( data === +data + "" ) { - return +data; - } - - if ( rbrace.test( data ) ) { - return JSON.parse( data ); - } - - return data; -} - -function dataAttr( elem, key, data ) { - var name; - - // If nothing was found internally, try to fetch any - // data from the HTML5 data-* attribute - if ( data === undefined && elem.nodeType === 1 ) { - name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); - data = elem.getAttribute( name ); - - if ( typeof data === "string" ) { - try { - data = getData( data ); - } catch ( e ) {} - - // Make sure we set the data so it isn't changed later - dataUser.set( elem, key, data ); - } else { - data = undefined; - } - } - return data; -} - -jQuery.extend( { - hasData: function( elem ) { - return dataUser.hasData( elem ) || dataPriv.hasData( elem ); - }, - - data: function( elem, name, data ) { - return dataUser.access( elem, name, data ); - }, - - removeData: function( elem, name ) { - dataUser.remove( elem, name ); - }, - - // TODO: Now that all calls to _data and _removeData have been replaced - // with direct calls to dataPriv methods, these can be deprecated. - _data: function( elem, name, data ) { - return dataPriv.access( elem, name, data ); - }, - - _removeData: function( elem, name ) { - dataPriv.remove( elem, name ); - } -} ); - -jQuery.fn.extend( { - data: function( key, value ) { - var i, name, data, - elem = this[ 0 ], - attrs = elem && elem.attributes; - - // Gets all values - if ( key === undefined ) { - if ( this.length ) { - data = dataUser.get( elem ); - - if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { - i = attrs.length; - while ( i-- ) { - - // Support: IE 11 only - // The attrs elements can be null (#14894) - if ( attrs[ i ] ) { - name = attrs[ i ].name; - if ( name.indexOf( "data-" ) === 0 ) { - name = camelCase( name.slice( 5 ) ); - dataAttr( elem, name, data[ name ] ); - } - } - } - dataPriv.set( elem, "hasDataAttrs", true ); - } - } - - return data; - } - - // Sets multiple values - if ( typeof key === "object" ) { - return this.each( function() { - dataUser.set( this, key ); - } ); - } - - return access( this, function( value ) { - var data; - - // The calling jQuery object (element matches) is not empty - // (and therefore has an element appears at this[ 0 ]) and the - // `value` parameter was not undefined. An empty jQuery object - // will result in `undefined` for elem = this[ 0 ] which will - // throw an exception if an attempt to read a data cache is made. - if ( elem && value === undefined ) { - - // Attempt to get data from the cache - // The key will always be camelCased in Data - data = dataUser.get( elem, key ); - if ( data !== undefined ) { - return data; - } - - // Attempt to "discover" the data in - // HTML5 custom data-* attrs - data = dataAttr( elem, key ); - if ( data !== undefined ) { - return data; - } - - // We tried really hard, but the data doesn't exist. - return; - } - - // Set the data... - this.each( function() { - - // We always store the camelCased key - dataUser.set( this, key, value ); - } ); - }, null, value, arguments.length > 1, null, true ); - }, - - removeData: function( key ) { - return this.each( function() { - dataUser.remove( this, key ); - } ); - } -} ); - - -jQuery.extend( { - queue: function( elem, type, data ) { - var queue; - - if ( elem ) { - type = ( type || "fx" ) + "queue"; - queue = dataPriv.get( elem, type ); - - // Speed up dequeue by getting out quickly if this is just a lookup - if ( data ) { - if ( !queue || Array.isArray( data ) ) { - queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); - } else { - queue.push( data ); - } - } - return queue || []; - } - }, - - dequeue: function( elem, type ) { - type = type || "fx"; - - var queue = jQuery.queue( elem, type ), - startLength = queue.length, - fn = queue.shift(), - hooks = jQuery._queueHooks( elem, type ), - next = function() { - jQuery.dequeue( elem, type ); - }; - - // If the fx queue is dequeued, always remove the progress sentinel - if ( fn === "inprogress" ) { - fn = queue.shift(); - startLength--; - } - - if ( fn ) { - - // Add a progress sentinel to prevent the fx queue from being - // automatically dequeued - if ( type === "fx" ) { - queue.unshift( "inprogress" ); - } - - // Clear up the last queue stop function - delete hooks.stop; - fn.call( elem, next, hooks ); - } - - if ( !startLength && hooks ) { - hooks.empty.fire(); - } - }, - - // Not public - generate a queueHooks object, or return the current one - _queueHooks: function( elem, type ) { - var key = type + "queueHooks"; - return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { - empty: jQuery.Callbacks( "once memory" ).add( function() { - dataPriv.remove( elem, [ type + "queue", key ] ); - } ) - } ); - } -} ); - -jQuery.fn.extend( { - queue: function( type, data ) { - var setter = 2; - - if ( typeof type !== "string" ) { - data = type; - type = "fx"; - setter--; - } - - if ( arguments.length < setter ) { - return jQuery.queue( this[ 0 ], type ); - } - - return data === undefined ? - this : - this.each( function() { - var queue = jQuery.queue( this, type, data ); - - // Ensure a hooks for this queue - jQuery._queueHooks( this, type ); - - if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { - jQuery.dequeue( this, type ); - } - } ); - }, - dequeue: function( type ) { - return this.each( function() { - jQuery.dequeue( this, type ); - } ); - }, - clearQueue: function( type ) { - return this.queue( type || "fx", [] ); - }, - - // Get a promise resolved when queues of a certain type - // are emptied (fx is the type by default) - promise: function( type, obj ) { - var tmp, - count = 1, - defer = jQuery.Deferred(), - elements = this, - i = this.length, - resolve = function() { - if ( !( --count ) ) { - defer.resolveWith( elements, [ elements ] ); - } - }; - - if ( typeof type !== "string" ) { - obj = type; - type = undefined; - } - type = type || "fx"; - - while ( i-- ) { - tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); - if ( tmp && tmp.empty ) { - count++; - tmp.empty.add( resolve ); - } - } - resolve(); - return defer.promise( obj ); - } -} ); -var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; - -var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); - - -var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; - -var documentElement = document.documentElement; - - - - var isAttached = function( elem ) { - return jQuery.contains( elem.ownerDocument, elem ); - }, - composed = { composed: true }; - - // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only - // Check attachment across shadow DOM boundaries when possible (gh-3504) - // Support: iOS 10.0-10.2 only - // Early iOS 10 versions support `attachShadow` but not `getRootNode`, - // leading to errors. We need to check for `getRootNode`. - if ( documentElement.getRootNode ) { - isAttached = function( elem ) { - return jQuery.contains( elem.ownerDocument, elem ) || - elem.getRootNode( composed ) === elem.ownerDocument; - }; - } -var isHiddenWithinTree = function( elem, el ) { - - // isHiddenWithinTree might be called from jQuery#filter function; - // in that case, element will be second argument - elem = el || elem; - - // Inline style trumps all - return elem.style.display === "none" || - elem.style.display === "" && - - // Otherwise, check computed style - // Support: Firefox <=43 - 45 - // Disconnected elements can have computed display: none, so first confirm that elem is - // in the document. - isAttached( elem ) && - - jQuery.css( elem, "display" ) === "none"; - }; - -var swap = function( elem, options, callback, args ) { - var ret, name, - old = {}; - - // Remember the old values, and insert the new ones - for ( name in options ) { - old[ name ] = elem.style[ name ]; - elem.style[ name ] = options[ name ]; - } - - ret = callback.apply( elem, args || [] ); - - // Revert the old values - for ( name in options ) { - elem.style[ name ] = old[ name ]; - } - - return ret; -}; - - - - -function adjustCSS( elem, prop, valueParts, tween ) { - var adjusted, scale, - maxIterations = 20, - currentValue = tween ? - function() { - return tween.cur(); - } : - function() { - return jQuery.css( elem, prop, "" ); - }, - initial = currentValue(), - unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), - - // Starting value computation is required for potential unit mismatches - initialInUnit = elem.nodeType && - ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && - rcssNum.exec( jQuery.css( elem, prop ) ); - - if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { - - // Support: Firefox <=54 - // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) - initial = initial / 2; - - // Trust units reported by jQuery.css - unit = unit || initialInUnit[ 3 ]; - - // Iteratively approximate from a nonzero starting point - initialInUnit = +initial || 1; - - while ( maxIterations-- ) { - - // Evaluate and update our best guess (doubling guesses that zero out). - // Finish if the scale equals or crosses 1 (making the old*new product non-positive). - jQuery.style( elem, prop, initialInUnit + unit ); - if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { - maxIterations = 0; - } - initialInUnit = initialInUnit / scale; - - } - - initialInUnit = initialInUnit * 2; - jQuery.style( elem, prop, initialInUnit + unit ); - - // Make sure we update the tween properties later on - valueParts = valueParts || []; - } - - if ( valueParts ) { - initialInUnit = +initialInUnit || +initial || 0; - - // Apply relative offset (+=/-=) if specified - adjusted = valueParts[ 1 ] ? - initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : - +valueParts[ 2 ]; - if ( tween ) { - tween.unit = unit; - tween.start = initialInUnit; - tween.end = adjusted; - } - } - return adjusted; -} - - -var defaultDisplayMap = {}; - -function getDefaultDisplay( elem ) { - var temp, - doc = elem.ownerDocument, - nodeName = elem.nodeName, - display = defaultDisplayMap[ nodeName ]; - - if ( display ) { - return display; - } - - temp = doc.body.appendChild( doc.createElement( nodeName ) ); - display = jQuery.css( temp, "display" ); - - temp.parentNode.removeChild( temp ); - - if ( display === "none" ) { - display = "block"; - } - defaultDisplayMap[ nodeName ] = display; - - return display; -} - -function showHide( elements, show ) { - var display, elem, - values = [], - index = 0, - length = elements.length; - - // Determine new display value for elements that need to change - for ( ; index < length; index++ ) { - elem = elements[ index ]; - if ( !elem.style ) { - continue; - } - - display = elem.style.display; - if ( show ) { - - // Since we force visibility upon cascade-hidden elements, an immediate (and slow) - // check is required in this first loop unless we have a nonempty display value (either - // inline or about-to-be-restored) - if ( display === "none" ) { - values[ index ] = dataPriv.get( elem, "display" ) || null; - if ( !values[ index ] ) { - elem.style.display = ""; - } - } - if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { - values[ index ] = getDefaultDisplay( elem ); - } - } else { - if ( display !== "none" ) { - values[ index ] = "none"; - - // Remember what we're overwriting - dataPriv.set( elem, "display", display ); - } - } - } - - // Set the display of the elements in a second loop to avoid constant reflow - for ( index = 0; index < length; index++ ) { - if ( values[ index ] != null ) { - elements[ index ].style.display = values[ index ]; - } - } - - return elements; -} - -jQuery.fn.extend( { - show: function() { - return showHide( this, true ); - }, - hide: function() { - return showHide( this ); - }, - toggle: function( state ) { - if ( typeof state === "boolean" ) { - return state ? this.show() : this.hide(); - } - - return this.each( function() { - if ( isHiddenWithinTree( this ) ) { - jQuery( this ).show(); - } else { - jQuery( this ).hide(); - } - } ); - } -} ); -var rcheckableType = ( /^(?:checkbox|radio)$/i ); - -var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); - -var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); - - - -// We have to close these tags to support XHTML (#13200) -var wrapMap = { - - // Support: IE <=9 only - option: [ 1, "" ], - - // XHTML parsers do not magically insert elements in the - // same way that tag soup parsers do. So we cannot shorten - // this by omitting or other required elements. - thead: [ 1, "", "
" ], - col: [ 2, "", "
" ], - tr: [ 2, "", "
" ], - td: [ 3, "", "
" ], - - _default: [ 0, "", "" ] -}; - -// Support: IE <=9 only -wrapMap.optgroup = wrapMap.option; - -wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; -wrapMap.th = wrapMap.td; - - -function getAll( context, tag ) { - - // Support: IE <=9 - 11 only - // Use typeof to avoid zero-argument method invocation on host objects (#15151) - var ret; - - if ( typeof context.getElementsByTagName !== "undefined" ) { - ret = context.getElementsByTagName( tag || "*" ); - - } else if ( typeof context.querySelectorAll !== "undefined" ) { - ret = context.querySelectorAll( tag || "*" ); - - } else { - ret = []; - } - - if ( tag === undefined || tag && nodeName( context, tag ) ) { - return jQuery.merge( [ context ], ret ); - } - - return ret; -} - - -// Mark scripts as having already been evaluated -function setGlobalEval( elems, refElements ) { - var i = 0, - l = elems.length; - - for ( ; i < l; i++ ) { - dataPriv.set( - elems[ i ], - "globalEval", - !refElements || dataPriv.get( refElements[ i ], "globalEval" ) - ); - } -} - - -var rhtml = /<|&#?\w+;/; - -function buildFragment( elems, context, scripts, selection, ignored ) { - var elem, tmp, tag, wrap, attached, j, - fragment = context.createDocumentFragment(), - nodes = [], - i = 0, - l = elems.length; - - for ( ; i < l; i++ ) { - elem = elems[ i ]; - - if ( elem || elem === 0 ) { - - // Add nodes directly - if ( toType( elem ) === "object" ) { - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); - - // Convert non-html into a text node - } else if ( !rhtml.test( elem ) ) { - nodes.push( context.createTextNode( elem ) ); - - // Convert html into DOM nodes - } else { - tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); - - // Deserialize a standard representation - tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); - wrap = wrapMap[ tag ] || wrapMap._default; - tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; - - // Descend through wrappers to the right content - j = wrap[ 0 ]; - while ( j-- ) { - tmp = tmp.lastChild; - } - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( nodes, tmp.childNodes ); - - // Remember the top-level container - tmp = fragment.firstChild; - - // Ensure the created nodes are orphaned (#12392) - tmp.textContent = ""; - } - } - } - - // Remove wrapper from fragment - fragment.textContent = ""; - - i = 0; - while ( ( elem = nodes[ i++ ] ) ) { - - // Skip elements already in the context collection (trac-4087) - if ( selection && jQuery.inArray( elem, selection ) > -1 ) { - if ( ignored ) { - ignored.push( elem ); - } - continue; - } - - attached = isAttached( elem ); - - // Append to fragment - tmp = getAll( fragment.appendChild( elem ), "script" ); - - // Preserve script evaluation history - if ( attached ) { - setGlobalEval( tmp ); - } - - // Capture executables - if ( scripts ) { - j = 0; - while ( ( elem = tmp[ j++ ] ) ) { - if ( rscriptType.test( elem.type || "" ) ) { - scripts.push( elem ); - } - } - } - } - - return fragment; -} - - -( function() { - var fragment = document.createDocumentFragment(), - div = fragment.appendChild( document.createElement( "div" ) ), - input = document.createElement( "input" ); - - // Support: Android 4.0 - 4.3 only - // Check state lost if the name is set (#11217) - // Support: Windows Web Apps (WWA) - // `name` and `type` must use .setAttribute for WWA (#14901) - input.setAttribute( "type", "radio" ); - input.setAttribute( "checked", "checked" ); - input.setAttribute( "name", "t" ); - - div.appendChild( input ); - - // Support: Android <=4.1 only - // Older WebKit doesn't clone checked state correctly in fragments - support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; - - // Support: IE <=11 only - // Make sure textarea (and checkbox) defaultValue is properly cloned - div.innerHTML = ""; - support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; -} )(); - - -var - rkeyEvent = /^key/, - rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, - rtypenamespace = /^([^.]*)(?:\.(.+)|)/; - -function returnTrue() { - return true; -} - -function returnFalse() { - return false; -} - -// Support: IE <=9 - 11+ -// focus() and blur() are asynchronous, except when they are no-op. -// So expect focus to be synchronous when the element is already active, -// and blur to be synchronous when the element is not already active. -// (focus and blur are always synchronous in other supported browsers, -// this just defines when we can count on it). -function expectSync( elem, type ) { - return ( elem === safeActiveElement() ) === ( type === "focus" ); -} - -// Support: IE <=9 only -// Accessing document.activeElement can throw unexpectedly -// https://bugs.jquery.com/ticket/13393 -function safeActiveElement() { - try { - return document.activeElement; - } catch ( err ) { } -} - -function on( elem, types, selector, data, fn, one ) { - var origFn, type; - - // Types can be a map of types/handlers - if ( typeof types === "object" ) { - - // ( types-Object, selector, data ) - if ( typeof selector !== "string" ) { - - // ( types-Object, data ) - data = data || selector; - selector = undefined; - } - for ( type in types ) { - on( elem, type, selector, data, types[ type ], one ); - } - return elem; - } - - if ( data == null && fn == null ) { - - // ( types, fn ) - fn = selector; - data = selector = undefined; - } else if ( fn == null ) { - if ( typeof selector === "string" ) { - - // ( types, selector, fn ) - fn = data; - data = undefined; - } else { - - // ( types, data, fn ) - fn = data; - data = selector; - selector = undefined; - } - } - if ( fn === false ) { - fn = returnFalse; - } else if ( !fn ) { - return elem; - } - - if ( one === 1 ) { - origFn = fn; - fn = function( event ) { - - // Can use an empty set, since event contains the info - jQuery().off( event ); - return origFn.apply( this, arguments ); - }; - - // Use same guid so caller can remove using origFn - fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); - } - return elem.each( function() { - jQuery.event.add( this, types, fn, data, selector ); - } ); -} - -/* - * Helper functions for managing events -- not part of the public interface. - * Props to Dean Edwards' addEvent library for many of the ideas. - */ -jQuery.event = { - - global: {}, - - add: function( elem, types, handler, data, selector ) { - - var handleObjIn, eventHandle, tmp, - events, t, handleObj, - special, handlers, type, namespaces, origType, - elemData = dataPriv.get( elem ); - - // Don't attach events to noData or text/comment nodes (but allow plain objects) - if ( !elemData ) { - return; - } - - // Caller can pass in an object of custom data in lieu of the handler - if ( handler.handler ) { - handleObjIn = handler; - handler = handleObjIn.handler; - selector = handleObjIn.selector; - } - - // Ensure that invalid selectors throw exceptions at attach time - // Evaluate against documentElement in case elem is a non-element node (e.g., document) - if ( selector ) { - jQuery.find.matchesSelector( documentElement, selector ); - } - - // Make sure that the handler has a unique ID, used to find/remove it later - if ( !handler.guid ) { - handler.guid = jQuery.guid++; - } - - // Init the element's event structure and main handler, if this is the first - if ( !( events = elemData.events ) ) { - events = elemData.events = {}; - } - if ( !( eventHandle = elemData.handle ) ) { - eventHandle = elemData.handle = function( e ) { - - // Discard the second event of a jQuery.event.trigger() and - // when an event is called after a page has unloaded - return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? - jQuery.event.dispatch.apply( elem, arguments ) : undefined; - }; - } - - // Handle multiple events separated by a space - types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[ t ] ) || []; - type = origType = tmp[ 1 ]; - namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); - - // There *must* be a type, no attaching namespace-only handlers - if ( !type ) { - continue; - } - - // If event changes its type, use the special event handlers for the changed type - special = jQuery.event.special[ type ] || {}; - - // If selector defined, determine special event api type, otherwise given type - type = ( selector ? special.delegateType : special.bindType ) || type; - - // Update special based on newly reset type - special = jQuery.event.special[ type ] || {}; - - // handleObj is passed to all event handlers - handleObj = jQuery.extend( { - type: type, - origType: origType, - data: data, - handler: handler, - guid: handler.guid, - selector: selector, - needsContext: selector && jQuery.expr.match.needsContext.test( selector ), - namespace: namespaces.join( "." ) - }, handleObjIn ); - - // Init the event handler queue if we're the first - if ( !( handlers = events[ type ] ) ) { - handlers = events[ type ] = []; - handlers.delegateCount = 0; - - // Only use addEventListener if the special events handler returns false - if ( !special.setup || - special.setup.call( elem, data, namespaces, eventHandle ) === false ) { - - if ( elem.addEventListener ) { - elem.addEventListener( type, eventHandle ); - } - } - } - - if ( special.add ) { - special.add.call( elem, handleObj ); - - if ( !handleObj.handler.guid ) { - handleObj.handler.guid = handler.guid; - } - } - - // Add to the element's handler list, delegates in front - if ( selector ) { - handlers.splice( handlers.delegateCount++, 0, handleObj ); - } else { - handlers.push( handleObj ); - } - - // Keep track of which events have ever been used, for event optimization - jQuery.event.global[ type ] = true; - } - - }, - - // Detach an event or set of events from an element - remove: function( elem, types, handler, selector, mappedTypes ) { - - var j, origCount, tmp, - events, t, handleObj, - special, handlers, type, namespaces, origType, - elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); - - if ( !elemData || !( events = elemData.events ) ) { - return; - } - - // Once for each type.namespace in types; type may be omitted - types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[ t ] ) || []; - type = origType = tmp[ 1 ]; - namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); - - // Unbind all events (on this namespace, if provided) for the element - if ( !type ) { - for ( type in events ) { - jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); - } - continue; - } - - special = jQuery.event.special[ type ] || {}; - type = ( selector ? special.delegateType : special.bindType ) || type; - handlers = events[ type ] || []; - tmp = tmp[ 2 ] && - new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); - - // Remove matching events - origCount = j = handlers.length; - while ( j-- ) { - handleObj = handlers[ j ]; - - if ( ( mappedTypes || origType === handleObj.origType ) && - ( !handler || handler.guid === handleObj.guid ) && - ( !tmp || tmp.test( handleObj.namespace ) ) && - ( !selector || selector === handleObj.selector || - selector === "**" && handleObj.selector ) ) { - handlers.splice( j, 1 ); - - if ( handleObj.selector ) { - handlers.delegateCount--; - } - if ( special.remove ) { - special.remove.call( elem, handleObj ); - } - } - } - - // Remove generic event handler if we removed something and no more handlers exist - // (avoids potential for endless recursion during removal of special event handlers) - if ( origCount && !handlers.length ) { - if ( !special.teardown || - special.teardown.call( elem, namespaces, elemData.handle ) === false ) { - - jQuery.removeEvent( elem, type, elemData.handle ); - } - - delete events[ type ]; - } - } - - // Remove data and the expando if it's no longer used - if ( jQuery.isEmptyObject( events ) ) { - dataPriv.remove( elem, "handle events" ); - } - }, - - dispatch: function( nativeEvent ) { - - // Make a writable jQuery.Event from the native event object - var event = jQuery.event.fix( nativeEvent ); - - var i, j, ret, matched, handleObj, handlerQueue, - args = new Array( arguments.length ), - handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], - special = jQuery.event.special[ event.type ] || {}; - - // Use the fix-ed jQuery.Event rather than the (read-only) native event - args[ 0 ] = event; - - for ( i = 1; i < arguments.length; i++ ) { - args[ i ] = arguments[ i ]; - } - - event.delegateTarget = this; - - // Call the preDispatch hook for the mapped type, and let it bail if desired - if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { - return; - } - - // Determine handlers - handlerQueue = jQuery.event.handlers.call( this, event, handlers ); - - // Run delegates first; they may want to stop propagation beneath us - i = 0; - while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { - event.currentTarget = matched.elem; - - j = 0; - while ( ( handleObj = matched.handlers[ j++ ] ) && - !event.isImmediatePropagationStopped() ) { - - // If the event is namespaced, then each handler is only invoked if it is - // specially universal or its namespaces are a superset of the event's. - if ( !event.rnamespace || handleObj.namespace === false || - event.rnamespace.test( handleObj.namespace ) ) { - - event.handleObj = handleObj; - event.data = handleObj.data; - - ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || - handleObj.handler ).apply( matched.elem, args ); - - if ( ret !== undefined ) { - if ( ( event.result = ret ) === false ) { - event.preventDefault(); - event.stopPropagation(); - } - } - } - } - } - - // Call the postDispatch hook for the mapped type - if ( special.postDispatch ) { - special.postDispatch.call( this, event ); - } - - return event.result; - }, - - handlers: function( event, handlers ) { - var i, handleObj, sel, matchedHandlers, matchedSelectors, - handlerQueue = [], - delegateCount = handlers.delegateCount, - cur = event.target; - - // Find delegate handlers - if ( delegateCount && - - // Support: IE <=9 - // Black-hole SVG instance trees (trac-13180) - cur.nodeType && - - // Support: Firefox <=42 - // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) - // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click - // Support: IE 11 only - // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) - !( event.type === "click" && event.button >= 1 ) ) { - - for ( ; cur !== this; cur = cur.parentNode || this ) { - - // Don't check non-elements (#13208) - // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) - if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { - matchedHandlers = []; - matchedSelectors = {}; - for ( i = 0; i < delegateCount; i++ ) { - handleObj = handlers[ i ]; - - // Don't conflict with Object.prototype properties (#13203) - sel = handleObj.selector + " "; - - if ( matchedSelectors[ sel ] === undefined ) { - matchedSelectors[ sel ] = handleObj.needsContext ? - jQuery( sel, this ).index( cur ) > -1 : - jQuery.find( sel, this, null, [ cur ] ).length; - } - if ( matchedSelectors[ sel ] ) { - matchedHandlers.push( handleObj ); - } - } - if ( matchedHandlers.length ) { - handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); - } - } - } - } - - // Add the remaining (directly-bound) handlers - cur = this; - if ( delegateCount < handlers.length ) { - handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); - } - - return handlerQueue; - }, - - addProp: function( name, hook ) { - Object.defineProperty( jQuery.Event.prototype, name, { - enumerable: true, - configurable: true, - - get: isFunction( hook ) ? - function() { - if ( this.originalEvent ) { - return hook( this.originalEvent ); - } - } : - function() { - if ( this.originalEvent ) { - return this.originalEvent[ name ]; - } - }, - - set: function( value ) { - Object.defineProperty( this, name, { - enumerable: true, - configurable: true, - writable: true, - value: value - } ); - } - } ); - }, - - fix: function( originalEvent ) { - return originalEvent[ jQuery.expando ] ? - originalEvent : - new jQuery.Event( originalEvent ); - }, - - special: { - load: { - - // Prevent triggered image.load events from bubbling to window.load - noBubble: true - }, - click: { - - // Utilize native event to ensure correct state for checkable inputs - setup: function( data ) { - - // For mutual compressibility with _default, replace `this` access with a local var. - // `|| data` is dead code meant only to preserve the variable through minification. - var el = this || data; - - // Claim the first handler - if ( rcheckableType.test( el.type ) && - el.click && nodeName( el, "input" ) ) { - - // dataPriv.set( el, "click", ... ) - leverageNative( el, "click", returnTrue ); - } - - // Return false to allow normal processing in the caller - return false; - }, - trigger: function( data ) { - - // For mutual compressibility with _default, replace `this` access with a local var. - // `|| data` is dead code meant only to preserve the variable through minification. - var el = this || data; - - // Force setup before triggering a click - if ( rcheckableType.test( el.type ) && - el.click && nodeName( el, "input" ) ) { - - leverageNative( el, "click" ); - } - - // Return non-false to allow normal event-path propagation - return true; - }, - - // For cross-browser consistency, suppress native .click() on links - // Also prevent it if we're currently inside a leveraged native-event stack - _default: function( event ) { - var target = event.target; - return rcheckableType.test( target.type ) && - target.click && nodeName( target, "input" ) && - dataPriv.get( target, "click" ) || - nodeName( target, "a" ); - } - }, - - beforeunload: { - postDispatch: function( event ) { - - // Support: Firefox 20+ - // Firefox doesn't alert if the returnValue field is not set. - if ( event.result !== undefined && event.originalEvent ) { - event.originalEvent.returnValue = event.result; - } - } - } - } -}; - -// Ensure the presence of an event listener that handles manually-triggered -// synthetic events by interrupting progress until reinvoked in response to -// *native* events that it fires directly, ensuring that state changes have -// already occurred before other listeners are invoked. -function leverageNative( el, type, expectSync ) { - - // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add - if ( !expectSync ) { - if ( dataPriv.get( el, type ) === undefined ) { - jQuery.event.add( el, type, returnTrue ); - } - return; - } - - // Register the controller as a special universal handler for all event namespaces - dataPriv.set( el, type, false ); - jQuery.event.add( el, type, { - namespace: false, - handler: function( event ) { - var notAsync, result, - saved = dataPriv.get( this, type ); - - if ( ( event.isTrigger & 1 ) && this[ type ] ) { - - // Interrupt processing of the outer synthetic .trigger()ed event - // Saved data should be false in such cases, but might be a leftover capture object - // from an async native handler (gh-4350) - if ( !saved.length ) { - - // Store arguments for use when handling the inner native event - // There will always be at least one argument (an event object), so this array - // will not be confused with a leftover capture object. - saved = slice.call( arguments ); - dataPriv.set( this, type, saved ); - - // Trigger the native event and capture its result - // Support: IE <=9 - 11+ - // focus() and blur() are asynchronous - notAsync = expectSync( this, type ); - this[ type ](); - result = dataPriv.get( this, type ); - if ( saved !== result || notAsync ) { - dataPriv.set( this, type, false ); - } else { - result = {}; - } - if ( saved !== result ) { - - // Cancel the outer synthetic event - event.stopImmediatePropagation(); - event.preventDefault(); - return result.value; - } - - // If this is an inner synthetic event for an event with a bubbling surrogate - // (focus or blur), assume that the surrogate already propagated from triggering the - // native event and prevent that from happening again here. - // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the - // bubbling surrogate propagates *after* the non-bubbling base), but that seems - // less bad than duplication. - } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { - event.stopPropagation(); - } - - // If this is a native event triggered above, everything is now in order - // Fire an inner synthetic event with the original arguments - } else if ( saved.length ) { - - // ...and capture the result - dataPriv.set( this, type, { - value: jQuery.event.trigger( - - // Support: IE <=9 - 11+ - // Extend with the prototype to reset the above stopImmediatePropagation() - jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), - saved.slice( 1 ), - this - ) - } ); - - // Abort handling of the native event - event.stopImmediatePropagation(); - } - } - } ); -} - -jQuery.removeEvent = function( elem, type, handle ) { - - // This "if" is needed for plain objects - if ( elem.removeEventListener ) { - elem.removeEventListener( type, handle ); - } -}; - -jQuery.Event = function( src, props ) { - - // Allow instantiation without the 'new' keyword - if ( !( this instanceof jQuery.Event ) ) { - return new jQuery.Event( src, props ); - } - - // Event object - if ( src && src.type ) { - this.originalEvent = src; - this.type = src.type; - - // Events bubbling up the document may have been marked as prevented - // by a handler lower down the tree; reflect the correct value. - this.isDefaultPrevented = src.defaultPrevented || - src.defaultPrevented === undefined && - - // Support: Android <=2.3 only - src.returnValue === false ? - returnTrue : - returnFalse; - - // Create target properties - // Support: Safari <=6 - 7 only - // Target should not be a text node (#504, #13143) - this.target = ( src.target && src.target.nodeType === 3 ) ? - src.target.parentNode : - src.target; - - this.currentTarget = src.currentTarget; - this.relatedTarget = src.relatedTarget; - - // Event type - } else { - this.type = src; - } - - // Put explicitly provided properties onto the event object - if ( props ) { - jQuery.extend( this, props ); - } - - // Create a timestamp if incoming event doesn't have one - this.timeStamp = src && src.timeStamp || Date.now(); - - // Mark it as fixed - this[ jQuery.expando ] = true; -}; - -// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding -// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html -jQuery.Event.prototype = { - constructor: jQuery.Event, - isDefaultPrevented: returnFalse, - isPropagationStopped: returnFalse, - isImmediatePropagationStopped: returnFalse, - isSimulated: false, - - preventDefault: function() { - var e = this.originalEvent; - - this.isDefaultPrevented = returnTrue; - - if ( e && !this.isSimulated ) { - e.preventDefault(); - } - }, - stopPropagation: function() { - var e = this.originalEvent; - - this.isPropagationStopped = returnTrue; - - if ( e && !this.isSimulated ) { - e.stopPropagation(); - } - }, - stopImmediatePropagation: function() { - var e = this.originalEvent; - - this.isImmediatePropagationStopped = returnTrue; - - if ( e && !this.isSimulated ) { - e.stopImmediatePropagation(); - } - - this.stopPropagation(); - } -}; - -// Includes all common event props including KeyEvent and MouseEvent specific props -jQuery.each( { - altKey: true, - bubbles: true, - cancelable: true, - changedTouches: true, - ctrlKey: true, - detail: true, - eventPhase: true, - metaKey: true, - pageX: true, - pageY: true, - shiftKey: true, - view: true, - "char": true, - code: true, - charCode: true, - key: true, - keyCode: true, - button: true, - buttons: true, - clientX: true, - clientY: true, - offsetX: true, - offsetY: true, - pointerId: true, - pointerType: true, - screenX: true, - screenY: true, - targetTouches: true, - toElement: true, - touches: true, - - which: function( event ) { - var button = event.button; - - // Add which for key events - if ( event.which == null && rkeyEvent.test( event.type ) ) { - return event.charCode != null ? event.charCode : event.keyCode; - } - - // Add which for click: 1 === left; 2 === middle; 3 === right - if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { - if ( button & 1 ) { - return 1; - } - - if ( button & 2 ) { - return 3; - } - - if ( button & 4 ) { - return 2; - } - - return 0; - } - - return event.which; - } -}, jQuery.event.addProp ); - -jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { - jQuery.event.special[ type ] = { - - // Utilize native event if possible so blur/focus sequence is correct - setup: function() { - - // Claim the first handler - // dataPriv.set( this, "focus", ... ) - // dataPriv.set( this, "blur", ... ) - leverageNative( this, type, expectSync ); - - // Return false to allow normal processing in the caller - return false; - }, - trigger: function() { - - // Force setup before trigger - leverageNative( this, type ); - - // Return non-false to allow normal event-path propagation - return true; - }, - - delegateType: delegateType - }; -} ); - -// Create mouseenter/leave events using mouseover/out and event-time checks -// so that event delegation works in jQuery. -// Do the same for pointerenter/pointerleave and pointerover/pointerout -// -// Support: Safari 7 only -// Safari sends mouseenter too often; see: -// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 -// for the description of the bug (it existed in older Chrome versions as well). -jQuery.each( { - mouseenter: "mouseover", - mouseleave: "mouseout", - pointerenter: "pointerover", - pointerleave: "pointerout" -}, function( orig, fix ) { - jQuery.event.special[ orig ] = { - delegateType: fix, - bindType: fix, - - handle: function( event ) { - var ret, - target = this, - related = event.relatedTarget, - handleObj = event.handleObj; - - // For mouseenter/leave call the handler if related is outside the target. - // NB: No relatedTarget if the mouse left/entered the browser window - if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { - event.type = handleObj.origType; - ret = handleObj.handler.apply( this, arguments ); - event.type = fix; - } - return ret; - } - }; -} ); - -jQuery.fn.extend( { - - on: function( types, selector, data, fn ) { - return on( this, types, selector, data, fn ); - }, - one: function( types, selector, data, fn ) { - return on( this, types, selector, data, fn, 1 ); - }, - off: function( types, selector, fn ) { - var handleObj, type; - if ( types && types.preventDefault && types.handleObj ) { - - // ( event ) dispatched jQuery.Event - handleObj = types.handleObj; - jQuery( types.delegateTarget ).off( - handleObj.namespace ? - handleObj.origType + "." + handleObj.namespace : - handleObj.origType, - handleObj.selector, - handleObj.handler - ); - return this; - } - if ( typeof types === "object" ) { - - // ( types-object [, selector] ) - for ( type in types ) { - this.off( type, selector, types[ type ] ); - } - return this; - } - if ( selector === false || typeof selector === "function" ) { - - // ( types [, fn] ) - fn = selector; - selector = undefined; - } - if ( fn === false ) { - fn = returnFalse; - } - return this.each( function() { - jQuery.event.remove( this, types, fn, selector ); - } ); - } -} ); - - -var - - /* eslint-disable max-len */ - - // See https://github.com/eslint/eslint/issues/3229 - rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, - - /* eslint-enable */ - - // Support: IE <=10 - 11, Edge 12 - 13 only - // In IE/Edge using regex groups here causes severe slowdowns. - // See https://connect.microsoft.com/IE/feedback/details/1736512/ - rnoInnerhtml = /\s*$/g; - -// Prefer a tbody over its parent table for containing new rows -function manipulationTarget( elem, content ) { - if ( nodeName( elem, "table" ) && - nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { - - return jQuery( elem ).children( "tbody" )[ 0 ] || elem; - } - - return elem; -} - -// Replace/restore the type attribute of script elements for safe DOM manipulation -function disableScript( elem ) { - elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; - return elem; -} -function restoreScript( elem ) { - if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { - elem.type = elem.type.slice( 5 ); - } else { - elem.removeAttribute( "type" ); - } - - return elem; -} - -function cloneCopyEvent( src, dest ) { - var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; - - if ( dest.nodeType !== 1 ) { - return; - } - - // 1. Copy private data: events, handlers, etc. - if ( dataPriv.hasData( src ) ) { - pdataOld = dataPriv.access( src ); - pdataCur = dataPriv.set( dest, pdataOld ); - events = pdataOld.events; - - if ( events ) { - delete pdataCur.handle; - pdataCur.events = {}; - - for ( type in events ) { - for ( i = 0, l = events[ type ].length; i < l; i++ ) { - jQuery.event.add( dest, type, events[ type ][ i ] ); - } - } - } - } - - // 2. Copy user data - if ( dataUser.hasData( src ) ) { - udataOld = dataUser.access( src ); - udataCur = jQuery.extend( {}, udataOld ); - - dataUser.set( dest, udataCur ); - } -} - -// Fix IE bugs, see support tests -function fixInput( src, dest ) { - var nodeName = dest.nodeName.toLowerCase(); - - // Fails to persist the checked state of a cloned checkbox or radio button. - if ( nodeName === "input" && rcheckableType.test( src.type ) ) { - dest.checked = src.checked; - - // Fails to return the selected option to the default selected state when cloning options - } else if ( nodeName === "input" || nodeName === "textarea" ) { - dest.defaultValue = src.defaultValue; - } -} - -function domManip( collection, args, callback, ignored ) { - - // Flatten any nested arrays - args = concat.apply( [], args ); - - var fragment, first, scripts, hasScripts, node, doc, - i = 0, - l = collection.length, - iNoClone = l - 1, - value = args[ 0 ], - valueIsFunction = isFunction( value ); - - // We can't cloneNode fragments that contain checked, in WebKit - if ( valueIsFunction || - ( l > 1 && typeof value === "string" && - !support.checkClone && rchecked.test( value ) ) ) { - return collection.each( function( index ) { - var self = collection.eq( index ); - if ( valueIsFunction ) { - args[ 0 ] = value.call( this, index, self.html() ); - } - domManip( self, args, callback, ignored ); - } ); - } - - if ( l ) { - fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); - first = fragment.firstChild; - - if ( fragment.childNodes.length === 1 ) { - fragment = first; - } - - // Require either new content or an interest in ignored elements to invoke the callback - if ( first || ignored ) { - scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); - hasScripts = scripts.length; - - // Use the original fragment for the last item - // instead of the first because it can end up - // being emptied incorrectly in certain situations (#8070). - for ( ; i < l; i++ ) { - node = fragment; - - if ( i !== iNoClone ) { - node = jQuery.clone( node, true, true ); - - // Keep references to cloned scripts for later restoration - if ( hasScripts ) { - - // Support: Android <=4.0 only, PhantomJS 1 only - // push.apply(_, arraylike) throws on ancient WebKit - jQuery.merge( scripts, getAll( node, "script" ) ); - } - } - - callback.call( collection[ i ], node, i ); - } - - if ( hasScripts ) { - doc = scripts[ scripts.length - 1 ].ownerDocument; - - // Reenable scripts - jQuery.map( scripts, restoreScript ); - - // Evaluate executable scripts on first document insertion - for ( i = 0; i < hasScripts; i++ ) { - node = scripts[ i ]; - if ( rscriptType.test( node.type || "" ) && - !dataPriv.access( node, "globalEval" ) && - jQuery.contains( doc, node ) ) { - - if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { - - // Optional AJAX dependency, but won't run scripts if not present - if ( jQuery._evalUrl && !node.noModule ) { - jQuery._evalUrl( node.src, { - nonce: node.nonce || node.getAttribute( "nonce" ) - } ); - } - } else { - DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); - } - } - } - } - } - } - - return collection; -} - -function remove( elem, selector, keepData ) { - var node, - nodes = selector ? jQuery.filter( selector, elem ) : elem, - i = 0; - - for ( ; ( node = nodes[ i ] ) != null; i++ ) { - if ( !keepData && node.nodeType === 1 ) { - jQuery.cleanData( getAll( node ) ); - } - - if ( node.parentNode ) { - if ( keepData && isAttached( node ) ) { - setGlobalEval( getAll( node, "script" ) ); - } - node.parentNode.removeChild( node ); - } - } - - return elem; -} - -jQuery.extend( { - htmlPrefilter: function( html ) { - return html.replace( rxhtmlTag, "<$1>" ); - }, - - clone: function( elem, dataAndEvents, deepDataAndEvents ) { - var i, l, srcElements, destElements, - clone = elem.cloneNode( true ), - inPage = isAttached( elem ); - - // Fix IE cloning issues - if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && - !jQuery.isXMLDoc( elem ) ) { - - // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 - destElements = getAll( clone ); - srcElements = getAll( elem ); - - for ( i = 0, l = srcElements.length; i < l; i++ ) { - fixInput( srcElements[ i ], destElements[ i ] ); - } - } - - // Copy the events from the original to the clone - if ( dataAndEvents ) { - if ( deepDataAndEvents ) { - srcElements = srcElements || getAll( elem ); - destElements = destElements || getAll( clone ); - - for ( i = 0, l = srcElements.length; i < l; i++ ) { - cloneCopyEvent( srcElements[ i ], destElements[ i ] ); - } - } else { - cloneCopyEvent( elem, clone ); - } - } - - // Preserve script evaluation history - destElements = getAll( clone, "script" ); - if ( destElements.length > 0 ) { - setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); - } - - // Return the cloned set - return clone; - }, - - cleanData: function( elems ) { - var data, elem, type, - special = jQuery.event.special, - i = 0; - - for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { - if ( acceptData( elem ) ) { - if ( ( data = elem[ dataPriv.expando ] ) ) { - if ( data.events ) { - for ( type in data.events ) { - if ( special[ type ] ) { - jQuery.event.remove( elem, type ); - - // This is a shortcut to avoid jQuery.event.remove's overhead - } else { - jQuery.removeEvent( elem, type, data.handle ); - } - } - } - - // Support: Chrome <=35 - 45+ - // Assign undefined instead of using delete, see Data#remove - elem[ dataPriv.expando ] = undefined; - } - if ( elem[ dataUser.expando ] ) { - - // Support: Chrome <=35 - 45+ - // Assign undefined instead of using delete, see Data#remove - elem[ dataUser.expando ] = undefined; - } - } - } - } -} ); - -jQuery.fn.extend( { - detach: function( selector ) { - return remove( this, selector, true ); - }, - - remove: function( selector ) { - return remove( this, selector ); - }, - - text: function( value ) { - return access( this, function( value ) { - return value === undefined ? - jQuery.text( this ) : - this.empty().each( function() { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - this.textContent = value; - } - } ); - }, null, value, arguments.length ); - }, - - append: function() { - return domManip( this, arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.appendChild( elem ); - } - } ); - }, - - prepend: function() { - return domManip( this, arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.insertBefore( elem, target.firstChild ); - } - } ); - }, - - before: function() { - return domManip( this, arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this ); - } - } ); - }, - - after: function() { - return domManip( this, arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this.nextSibling ); - } - } ); - }, - - empty: function() { - var elem, - i = 0; - - for ( ; ( elem = this[ i ] ) != null; i++ ) { - if ( elem.nodeType === 1 ) { - - // Prevent memory leaks - jQuery.cleanData( getAll( elem, false ) ); - - // Remove any remaining nodes - elem.textContent = ""; - } - } - - return this; - }, - - clone: function( dataAndEvents, deepDataAndEvents ) { - dataAndEvents = dataAndEvents == null ? false : dataAndEvents; - deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; - - return this.map( function() { - return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); - } ); - }, - - html: function( value ) { - return access( this, function( value ) { - var elem = this[ 0 ] || {}, - i = 0, - l = this.length; - - if ( value === undefined && elem.nodeType === 1 ) { - return elem.innerHTML; - } - - // See if we can take a shortcut and just use innerHTML - if ( typeof value === "string" && !rnoInnerhtml.test( value ) && - !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { - - value = jQuery.htmlPrefilter( value ); - - try { - for ( ; i < l; i++ ) { - elem = this[ i ] || {}; - - // Remove element nodes and prevent memory leaks - if ( elem.nodeType === 1 ) { - jQuery.cleanData( getAll( elem, false ) ); - elem.innerHTML = value; - } - } - - elem = 0; - - // If using innerHTML throws an exception, use the fallback method - } catch ( e ) {} - } - - if ( elem ) { - this.empty().append( value ); - } - }, null, value, arguments.length ); - }, - - replaceWith: function() { - var ignored = []; - - // Make the changes, replacing each non-ignored context element with the new content - return domManip( this, arguments, function( elem ) { - var parent = this.parentNode; - - if ( jQuery.inArray( this, ignored ) < 0 ) { - jQuery.cleanData( getAll( this ) ); - if ( parent ) { - parent.replaceChild( elem, this ); - } - } - - // Force callback invocation - }, ignored ); - } -} ); - -jQuery.each( { - appendTo: "append", - prependTo: "prepend", - insertBefore: "before", - insertAfter: "after", - replaceAll: "replaceWith" -}, function( name, original ) { - jQuery.fn[ name ] = function( selector ) { - var elems, - ret = [], - insert = jQuery( selector ), - last = insert.length - 1, - i = 0; - - for ( ; i <= last; i++ ) { - elems = i === last ? this : this.clone( true ); - jQuery( insert[ i ] )[ original ]( elems ); - - // Support: Android <=4.0 only, PhantomJS 1 only - // .get() because push.apply(_, arraylike) throws on ancient WebKit - push.apply( ret, elems.get() ); - } - - return this.pushStack( ret ); - }; -} ); -var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); - -var getStyles = function( elem ) { - - // Support: IE <=11 only, Firefox <=30 (#15098, #14150) - // IE throws on elements created in popups - // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" - var view = elem.ownerDocument.defaultView; - - if ( !view || !view.opener ) { - view = window; - } - - return view.getComputedStyle( elem ); - }; - -var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); - - - -( function() { - - // Executing both pixelPosition & boxSizingReliable tests require only one layout - // so they're executed at the same time to save the second computation. - function computeStyleTests() { - - // This is a singleton, we need to execute it only once - if ( !div ) { - return; - } - - container.style.cssText = "position:absolute;left:-11111px;width:60px;" + - "margin-top:1px;padding:0;border:0"; - div.style.cssText = - "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + - "margin:auto;border:1px;padding:1px;" + - "width:60%;top:1%"; - documentElement.appendChild( container ).appendChild( div ); - - var divStyle = window.getComputedStyle( div ); - pixelPositionVal = divStyle.top !== "1%"; - - // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 - reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; - - // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 - // Some styles come back with percentage values, even though they shouldn't - div.style.right = "60%"; - pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; - - // Support: IE 9 - 11 only - // Detect misreporting of content dimensions for box-sizing:border-box elements - boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; - - // Support: IE 9 only - // Detect overflow:scroll screwiness (gh-3699) - // Support: Chrome <=64 - // Don't get tricked when zoom affects offsetWidth (gh-4029) - div.style.position = "absolute"; - scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; - - documentElement.removeChild( container ); - - // Nullify the div so it wouldn't be stored in the memory and - // it will also be a sign that checks already performed - div = null; - } - - function roundPixelMeasures( measure ) { - return Math.round( parseFloat( measure ) ); - } - - var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, - reliableMarginLeftVal, - container = document.createElement( "div" ), - div = document.createElement( "div" ); - - // Finish early in limited (non-browser) environments - if ( !div.style ) { - return; - } - - // Support: IE <=9 - 11 only - // Style of cloned element affects source element cloned (#8908) - div.style.backgroundClip = "content-box"; - div.cloneNode( true ).style.backgroundClip = ""; - support.clearCloneStyle = div.style.backgroundClip === "content-box"; - - jQuery.extend( support, { - boxSizingReliable: function() { - computeStyleTests(); - return boxSizingReliableVal; - }, - pixelBoxStyles: function() { - computeStyleTests(); - return pixelBoxStylesVal; - }, - pixelPosition: function() { - computeStyleTests(); - return pixelPositionVal; - }, - reliableMarginLeft: function() { - computeStyleTests(); - return reliableMarginLeftVal; - }, - scrollboxSize: function() { - computeStyleTests(); - return scrollboxSizeVal; - } - } ); -} )(); - - -function curCSS( elem, name, computed ) { - var width, minWidth, maxWidth, ret, - - // Support: Firefox 51+ - // Retrieving style before computed somehow - // fixes an issue with getting wrong values - // on detached elements - style = elem.style; - - computed = computed || getStyles( elem ); - - // getPropertyValue is needed for: - // .css('filter') (IE 9 only, #12537) - // .css('--customProperty) (#3144) - if ( computed ) { - ret = computed.getPropertyValue( name ) || computed[ name ]; - - if ( ret === "" && !isAttached( elem ) ) { - ret = jQuery.style( elem, name ); - } - - // A tribute to the "awesome hack by Dean Edwards" - // Android Browser returns percentage for some values, - // but width seems to be reliably pixels. - // This is against the CSSOM draft spec: - // https://drafts.csswg.org/cssom/#resolved-values - if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { - - // Remember the original values - width = style.width; - minWidth = style.minWidth; - maxWidth = style.maxWidth; - - // Put in the new values to get a computed value out - style.minWidth = style.maxWidth = style.width = ret; - ret = computed.width; - - // Revert the changed values - style.width = width; - style.minWidth = minWidth; - style.maxWidth = maxWidth; - } - } - - return ret !== undefined ? - - // Support: IE <=9 - 11 only - // IE returns zIndex value as an integer. - ret + "" : - ret; -} - - -function addGetHookIf( conditionFn, hookFn ) { - - // Define the hook, we'll check on the first run if it's really needed. - return { - get: function() { - if ( conditionFn() ) { - - // Hook not needed (or it's not possible to use it due - // to missing dependency), remove it. - delete this.get; - return; - } - - // Hook needed; redefine it so that the support test is not executed again. - return ( this.get = hookFn ).apply( this, arguments ); - } - }; -} - - -var cssPrefixes = [ "Webkit", "Moz", "ms" ], - emptyStyle = document.createElement( "div" ).style, - vendorProps = {}; - -// Return a vendor-prefixed property or undefined -function vendorPropName( name ) { - - // Check for vendor prefixed names - var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), - i = cssPrefixes.length; - - while ( i-- ) { - name = cssPrefixes[ i ] + capName; - if ( name in emptyStyle ) { - return name; - } - } -} - -// Return a potentially-mapped jQuery.cssProps or vendor prefixed property -function finalPropName( name ) { - var final = jQuery.cssProps[ name ] || vendorProps[ name ]; - - if ( final ) { - return final; - } - if ( name in emptyStyle ) { - return name; - } - return vendorProps[ name ] = vendorPropName( name ) || name; -} - - -var - - // Swappable if display is none or starts with table - // except "table", "table-cell", or "table-caption" - // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display - rdisplayswap = /^(none|table(?!-c[ea]).+)/, - rcustomProp = /^--/, - cssShow = { position: "absolute", visibility: "hidden", display: "block" }, - cssNormalTransform = { - letterSpacing: "0", - fontWeight: "400" - }; - -function setPositiveNumber( elem, value, subtract ) { - - // Any relative (+/-) values have already been - // normalized at this point - var matches = rcssNum.exec( value ); - return matches ? - - // Guard against undefined "subtract", e.g., when used as in cssHooks - Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : - value; -} - -function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { - var i = dimension === "width" ? 1 : 0, - extra = 0, - delta = 0; - - // Adjustment may not be necessary - if ( box === ( isBorderBox ? "border" : "content" ) ) { - return 0; - } - - for ( ; i < 4; i += 2 ) { - - // Both box models exclude margin - if ( box === "margin" ) { - delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); - } - - // If we get here with a content-box, we're seeking "padding" or "border" or "margin" - if ( !isBorderBox ) { - - // Add padding - delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); - - // For "border" or "margin", add border - if ( box !== "padding" ) { - delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - - // But still keep track of it otherwise - } else { - extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - } - - // If we get here with a border-box (content + padding + border), we're seeking "content" or - // "padding" or "margin" - } else { - - // For "content", subtract padding - if ( box === "content" ) { - delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); - } - - // For "content" or "padding", subtract border - if ( box !== "margin" ) { - delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); - } - } - } - - // Account for positive content-box scroll gutter when requested by providing computedVal - if ( !isBorderBox && computedVal >= 0 ) { - - // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border - // Assuming integer scroll gutter, subtract the rest and round down - delta += Math.max( 0, Math.ceil( - elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - - computedVal - - delta - - extra - - 0.5 - - // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter - // Use an explicit zero to avoid NaN (gh-3964) - ) ) || 0; - } - - return delta; -} - -function getWidthOrHeight( elem, dimension, extra ) { - - // Start with computed style - var styles = getStyles( elem ), - - // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). - // Fake content-box until we know it's needed to know the true value. - boxSizingNeeded = !support.boxSizingReliable() || extra, - isBorderBox = boxSizingNeeded && - jQuery.css( elem, "boxSizing", false, styles ) === "border-box", - valueIsBorderBox = isBorderBox, - - val = curCSS( elem, dimension, styles ), - offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); - - // Support: Firefox <=54 - // Return a confounding non-pixel value or feign ignorance, as appropriate. - if ( rnumnonpx.test( val ) ) { - if ( !extra ) { - return val; - } - val = "auto"; - } - - - // Fall back to offsetWidth/offsetHeight when value is "auto" - // This happens for inline elements with no explicit setting (gh-3571) - // Support: Android <=4.1 - 4.3 only - // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) - // Support: IE 9-11 only - // Also use offsetWidth/offsetHeight for when box sizing is unreliable - // We use getClientRects() to check for hidden/disconnected. - // In those cases, the computed value can be trusted to be border-box - if ( ( !support.boxSizingReliable() && isBorderBox || - val === "auto" || - !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && - elem.getClientRects().length ) { - - isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; - - // Where available, offsetWidth/offsetHeight approximate border box dimensions. - // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the - // retrieved value as a content box dimension. - valueIsBorderBox = offsetProp in elem; - if ( valueIsBorderBox ) { - val = elem[ offsetProp ]; - } - } - - // Normalize "" and auto - val = parseFloat( val ) || 0; - - // Adjust for the element's box model - return ( val + - boxModelAdjustment( - elem, - dimension, - extra || ( isBorderBox ? "border" : "content" ), - valueIsBorderBox, - styles, - - // Provide the current computed size to request scroll gutter calculation (gh-3589) - val - ) - ) + "px"; -} - -jQuery.extend( { - - // Add in style property hooks for overriding the default - // behavior of getting and setting a style property - cssHooks: { - opacity: { - get: function( elem, computed ) { - if ( computed ) { - - // We should always get a number back from opacity - var ret = curCSS( elem, "opacity" ); - return ret === "" ? "1" : ret; - } - } - } - }, - - // Don't automatically add "px" to these possibly-unitless properties - cssNumber: { - "animationIterationCount": true, - "columnCount": true, - "fillOpacity": true, - "flexGrow": true, - "flexShrink": true, - "fontWeight": true, - "gridArea": true, - "gridColumn": true, - "gridColumnEnd": true, - "gridColumnStart": true, - "gridRow": true, - "gridRowEnd": true, - "gridRowStart": true, - "lineHeight": true, - "opacity": true, - "order": true, - "orphans": true, - "widows": true, - "zIndex": true, - "zoom": true - }, - - // Add in properties whose names you wish to fix before - // setting or getting the value - cssProps: {}, - - // Get and set the style property on a DOM Node - style: function( elem, name, value, extra ) { - - // Don't set styles on text and comment nodes - if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { - return; - } - - // Make sure that we're working with the right name - var ret, type, hooks, - origName = camelCase( name ), - isCustomProp = rcustomProp.test( name ), - style = elem.style; - - // Make sure that we're working with the right name. We don't - // want to query the value if it is a CSS custom property - // since they are user-defined. - if ( !isCustomProp ) { - name = finalPropName( origName ); - } - - // Gets hook for the prefixed version, then unprefixed version - hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; - - // Check if we're setting a value - if ( value !== undefined ) { - type = typeof value; - - // Convert "+=" or "-=" to relative numbers (#7345) - if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { - value = adjustCSS( elem, name, ret ); - - // Fixes bug #9237 - type = "number"; - } - - // Make sure that null and NaN values aren't set (#7116) - if ( value == null || value !== value ) { - return; - } - - // If a number was passed in, add the unit (except for certain CSS properties) - // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append - // "px" to a few hardcoded values. - if ( type === "number" && !isCustomProp ) { - value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); - } - - // background-* props affect original clone's values - if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { - style[ name ] = "inherit"; - } - - // If a hook was provided, use that value, otherwise just set the specified value - if ( !hooks || !( "set" in hooks ) || - ( value = hooks.set( elem, value, extra ) ) !== undefined ) { - - if ( isCustomProp ) { - style.setProperty( name, value ); - } else { - style[ name ] = value; - } - } - - } else { - - // If a hook was provided get the non-computed value from there - if ( hooks && "get" in hooks && - ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { - - return ret; - } - - // Otherwise just get the value from the style object - return style[ name ]; - } - }, - - css: function( elem, name, extra, styles ) { - var val, num, hooks, - origName = camelCase( name ), - isCustomProp = rcustomProp.test( name ); - - // Make sure that we're working with the right name. We don't - // want to modify the value if it is a CSS custom property - // since they are user-defined. - if ( !isCustomProp ) { - name = finalPropName( origName ); - } - - // Try prefixed name followed by the unprefixed name - hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; - - // If a hook was provided get the computed value from there - if ( hooks && "get" in hooks ) { - val = hooks.get( elem, true, extra ); - } - - // Otherwise, if a way to get the computed value exists, use that - if ( val === undefined ) { - val = curCSS( elem, name, styles ); - } - - // Convert "normal" to computed value - if ( val === "normal" && name in cssNormalTransform ) { - val = cssNormalTransform[ name ]; - } - - // Make numeric if forced or a qualifier was provided and val looks numeric - if ( extra === "" || extra ) { - num = parseFloat( val ); - return extra === true || isFinite( num ) ? num || 0 : val; - } - - return val; - } -} ); - -jQuery.each( [ "height", "width" ], function( i, dimension ) { - jQuery.cssHooks[ dimension ] = { - get: function( elem, computed, extra ) { - if ( computed ) { - - // Certain elements can have dimension info if we invisibly show them - // but it must have a current display style that would benefit - return rdisplayswap.test( jQuery.css( elem, "display" ) ) && - - // Support: Safari 8+ - // Table columns in Safari have non-zero offsetWidth & zero - // getBoundingClientRect().width unless display is changed. - // Support: IE <=11 only - // Running getBoundingClientRect on a disconnected node - // in IE throws an error. - ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? - swap( elem, cssShow, function() { - return getWidthOrHeight( elem, dimension, extra ); - } ) : - getWidthOrHeight( elem, dimension, extra ); - } - }, - - set: function( elem, value, extra ) { - var matches, - styles = getStyles( elem ), - - // Only read styles.position if the test has a chance to fail - // to avoid forcing a reflow. - scrollboxSizeBuggy = !support.scrollboxSize() && - styles.position === "absolute", - - // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) - boxSizingNeeded = scrollboxSizeBuggy || extra, - isBorderBox = boxSizingNeeded && - jQuery.css( elem, "boxSizing", false, styles ) === "border-box", - subtract = extra ? - boxModelAdjustment( - elem, - dimension, - extra, - isBorderBox, - styles - ) : - 0; - - // Account for unreliable border-box dimensions by comparing offset* to computed and - // faking a content-box to get border and padding (gh-3699) - if ( isBorderBox && scrollboxSizeBuggy ) { - subtract -= Math.ceil( - elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - - parseFloat( styles[ dimension ] ) - - boxModelAdjustment( elem, dimension, "border", false, styles ) - - 0.5 - ); - } - - // Convert to pixels if value adjustment is needed - if ( subtract && ( matches = rcssNum.exec( value ) ) && - ( matches[ 3 ] || "px" ) !== "px" ) { - - elem.style[ dimension ] = value; - value = jQuery.css( elem, dimension ); - } - - return setPositiveNumber( elem, value, subtract ); - } - }; -} ); - -jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, - function( elem, computed ) { - if ( computed ) { - return ( parseFloat( curCSS( elem, "marginLeft" ) ) || - elem.getBoundingClientRect().left - - swap( elem, { marginLeft: 0 }, function() { - return elem.getBoundingClientRect().left; - } ) - ) + "px"; - } - } -); - -// These hooks are used by animate to expand properties -jQuery.each( { - margin: "", - padding: "", - border: "Width" -}, function( prefix, suffix ) { - jQuery.cssHooks[ prefix + suffix ] = { - expand: function( value ) { - var i = 0, - expanded = {}, - - // Assumes a single number if not a string - parts = typeof value === "string" ? value.split( " " ) : [ value ]; - - for ( ; i < 4; i++ ) { - expanded[ prefix + cssExpand[ i ] + suffix ] = - parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; - } - - return expanded; - } - }; - - if ( prefix !== "margin" ) { - jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; - } -} ); - -jQuery.fn.extend( { - css: function( name, value ) { - return access( this, function( elem, name, value ) { - var styles, len, - map = {}, - i = 0; - - if ( Array.isArray( name ) ) { - styles = getStyles( elem ); - len = name.length; - - for ( ; i < len; i++ ) { - map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); - } - - return map; - } - - return value !== undefined ? - jQuery.style( elem, name, value ) : - jQuery.css( elem, name ); - }, name, value, arguments.length > 1 ); - } -} ); - - -function Tween( elem, options, prop, end, easing ) { - return new Tween.prototype.init( elem, options, prop, end, easing ); -} -jQuery.Tween = Tween; - -Tween.prototype = { - constructor: Tween, - init: function( elem, options, prop, end, easing, unit ) { - this.elem = elem; - this.prop = prop; - this.easing = easing || jQuery.easing._default; - this.options = options; - this.start = this.now = this.cur(); - this.end = end; - this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); - }, - cur: function() { - var hooks = Tween.propHooks[ this.prop ]; - - return hooks && hooks.get ? - hooks.get( this ) : - Tween.propHooks._default.get( this ); - }, - run: function( percent ) { - var eased, - hooks = Tween.propHooks[ this.prop ]; - - if ( this.options.duration ) { - this.pos = eased = jQuery.easing[ this.easing ]( - percent, this.options.duration * percent, 0, 1, this.options.duration - ); - } else { - this.pos = eased = percent; - } - this.now = ( this.end - this.start ) * eased + this.start; - - if ( this.options.step ) { - this.options.step.call( this.elem, this.now, this ); - } - - if ( hooks && hooks.set ) { - hooks.set( this ); - } else { - Tween.propHooks._default.set( this ); - } - return this; - } -}; - -Tween.prototype.init.prototype = Tween.prototype; - -Tween.propHooks = { - _default: { - get: function( tween ) { - var result; - - // Use a property on the element directly when it is not a DOM element, - // or when there is no matching style property that exists. - if ( tween.elem.nodeType !== 1 || - tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { - return tween.elem[ tween.prop ]; - } - - // Passing an empty string as a 3rd parameter to .css will automatically - // attempt a parseFloat and fallback to a string if the parse fails. - // Simple values such as "10px" are parsed to Float; - // complex values such as "rotate(1rad)" are returned as-is. - result = jQuery.css( tween.elem, tween.prop, "" ); - - // Empty strings, null, undefined and "auto" are converted to 0. - return !result || result === "auto" ? 0 : result; - }, - set: function( tween ) { - - // Use step hook for back compat. - // Use cssHook if its there. - // Use .style if available and use plain properties where available. - if ( jQuery.fx.step[ tween.prop ] ) { - jQuery.fx.step[ tween.prop ]( tween ); - } else if ( tween.elem.nodeType === 1 && ( - jQuery.cssHooks[ tween.prop ] || - tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { - jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); - } else { - tween.elem[ tween.prop ] = tween.now; - } - } - } -}; - -// Support: IE <=9 only -// Panic based approach to setting things on disconnected nodes -Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { - set: function( tween ) { - if ( tween.elem.nodeType && tween.elem.parentNode ) { - tween.elem[ tween.prop ] = tween.now; - } - } -}; - -jQuery.easing = { - linear: function( p ) { - return p; - }, - swing: function( p ) { - return 0.5 - Math.cos( p * Math.PI ) / 2; - }, - _default: "swing" -}; - -jQuery.fx = Tween.prototype.init; - -// Back compat <1.8 extension point -jQuery.fx.step = {}; - - - - -var - fxNow, inProgress, - rfxtypes = /^(?:toggle|show|hide)$/, - rrun = /queueHooks$/; - -function schedule() { - if ( inProgress ) { - if ( document.hidden === false && window.requestAnimationFrame ) { - window.requestAnimationFrame( schedule ); - } else { - window.setTimeout( schedule, jQuery.fx.interval ); - } - - jQuery.fx.tick(); - } -} - -// Animations created synchronously will run synchronously -function createFxNow() { - window.setTimeout( function() { - fxNow = undefined; - } ); - return ( fxNow = Date.now() ); -} - -// Generate parameters to create a standard animation -function genFx( type, includeWidth ) { - var which, - i = 0, - attrs = { height: type }; - - // If we include width, step value is 1 to do all cssExpand values, - // otherwise step value is 2 to skip over Left and Right - includeWidth = includeWidth ? 1 : 0; - for ( ; i < 4; i += 2 - includeWidth ) { - which = cssExpand[ i ]; - attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; - } - - if ( includeWidth ) { - attrs.opacity = attrs.width = type; - } - - return attrs; -} - -function createTween( value, prop, animation ) { - var tween, - collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), - index = 0, - length = collection.length; - for ( ; index < length; index++ ) { - if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { - - // We're done with this property - return tween; - } - } -} - -function defaultPrefilter( elem, props, opts ) { - var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, - isBox = "width" in props || "height" in props, - anim = this, - orig = {}, - style = elem.style, - hidden = elem.nodeType && isHiddenWithinTree( elem ), - dataShow = dataPriv.get( elem, "fxshow" ); - - // Queue-skipping animations hijack the fx hooks - if ( !opts.queue ) { - hooks = jQuery._queueHooks( elem, "fx" ); - if ( hooks.unqueued == null ) { - hooks.unqueued = 0; - oldfire = hooks.empty.fire; - hooks.empty.fire = function() { - if ( !hooks.unqueued ) { - oldfire(); - } - }; - } - hooks.unqueued++; - - anim.always( function() { - - // Ensure the complete handler is called before this completes - anim.always( function() { - hooks.unqueued--; - if ( !jQuery.queue( elem, "fx" ).length ) { - hooks.empty.fire(); - } - } ); - } ); - } - - // Detect show/hide animations - for ( prop in props ) { - value = props[ prop ]; - if ( rfxtypes.test( value ) ) { - delete props[ prop ]; - toggle = toggle || value === "toggle"; - if ( value === ( hidden ? "hide" : "show" ) ) { - - // Pretend to be hidden if this is a "show" and - // there is still data from a stopped show/hide - if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { - hidden = true; - - // Ignore all other no-op show/hide data - } else { - continue; - } - } - orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); - } - } - - // Bail out if this is a no-op like .hide().hide() - propTween = !jQuery.isEmptyObject( props ); - if ( !propTween && jQuery.isEmptyObject( orig ) ) { - return; - } - - // Restrict "overflow" and "display" styles during box animations - if ( isBox && elem.nodeType === 1 ) { - - // Support: IE <=9 - 11, Edge 12 - 15 - // Record all 3 overflow attributes because IE does not infer the shorthand - // from identically-valued overflowX and overflowY and Edge just mirrors - // the overflowX value there. - opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; - - // Identify a display type, preferring old show/hide data over the CSS cascade - restoreDisplay = dataShow && dataShow.display; - if ( restoreDisplay == null ) { - restoreDisplay = dataPriv.get( elem, "display" ); - } - display = jQuery.css( elem, "display" ); - if ( display === "none" ) { - if ( restoreDisplay ) { - display = restoreDisplay; - } else { - - // Get nonempty value(s) by temporarily forcing visibility - showHide( [ elem ], true ); - restoreDisplay = elem.style.display || restoreDisplay; - display = jQuery.css( elem, "display" ); - showHide( [ elem ] ); - } - } - - // Animate inline elements as inline-block - if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { - if ( jQuery.css( elem, "float" ) === "none" ) { - - // Restore the original display value at the end of pure show/hide animations - if ( !propTween ) { - anim.done( function() { - style.display = restoreDisplay; - } ); - if ( restoreDisplay == null ) { - display = style.display; - restoreDisplay = display === "none" ? "" : display; - } - } - style.display = "inline-block"; - } - } - } - - if ( opts.overflow ) { - style.overflow = "hidden"; - anim.always( function() { - style.overflow = opts.overflow[ 0 ]; - style.overflowX = opts.overflow[ 1 ]; - style.overflowY = opts.overflow[ 2 ]; - } ); - } - - // Implement show/hide animations - propTween = false; - for ( prop in orig ) { - - // General show/hide setup for this element animation - if ( !propTween ) { - if ( dataShow ) { - if ( "hidden" in dataShow ) { - hidden = dataShow.hidden; - } - } else { - dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); - } - - // Store hidden/visible for toggle so `.stop().toggle()` "reverses" - if ( toggle ) { - dataShow.hidden = !hidden; - } - - // Show elements before animating them - if ( hidden ) { - showHide( [ elem ], true ); - } - - /* eslint-disable no-loop-func */ - - anim.done( function() { - - /* eslint-enable no-loop-func */ - - // The final step of a "hide" animation is actually hiding the element - if ( !hidden ) { - showHide( [ elem ] ); - } - dataPriv.remove( elem, "fxshow" ); - for ( prop in orig ) { - jQuery.style( elem, prop, orig[ prop ] ); - } - } ); - } - - // Per-property setup - propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); - if ( !( prop in dataShow ) ) { - dataShow[ prop ] = propTween.start; - if ( hidden ) { - propTween.end = propTween.start; - propTween.start = 0; - } - } - } -} - -function propFilter( props, specialEasing ) { - var index, name, easing, value, hooks; - - // camelCase, specialEasing and expand cssHook pass - for ( index in props ) { - name = camelCase( index ); - easing = specialEasing[ name ]; - value = props[ index ]; - if ( Array.isArray( value ) ) { - easing = value[ 1 ]; - value = props[ index ] = value[ 0 ]; - } - - if ( index !== name ) { - props[ name ] = value; - delete props[ index ]; - } - - hooks = jQuery.cssHooks[ name ]; - if ( hooks && "expand" in hooks ) { - value = hooks.expand( value ); - delete props[ name ]; - - // Not quite $.extend, this won't overwrite existing keys. - // Reusing 'index' because we have the correct "name" - for ( index in value ) { - if ( !( index in props ) ) { - props[ index ] = value[ index ]; - specialEasing[ index ] = easing; - } - } - } else { - specialEasing[ name ] = easing; - } - } -} - -function Animation( elem, properties, options ) { - var result, - stopped, - index = 0, - length = Animation.prefilters.length, - deferred = jQuery.Deferred().always( function() { - - // Don't match elem in the :animated selector - delete tick.elem; - } ), - tick = function() { - if ( stopped ) { - return false; - } - var currentTime = fxNow || createFxNow(), - remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), - - // Support: Android 2.3 only - // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) - temp = remaining / animation.duration || 0, - percent = 1 - temp, - index = 0, - length = animation.tweens.length; - - for ( ; index < length; index++ ) { - animation.tweens[ index ].run( percent ); - } - - deferred.notifyWith( elem, [ animation, percent, remaining ] ); - - // If there's more to do, yield - if ( percent < 1 && length ) { - return remaining; - } - - // If this was an empty animation, synthesize a final progress notification - if ( !length ) { - deferred.notifyWith( elem, [ animation, 1, 0 ] ); - } - - // Resolve the animation and report its conclusion - deferred.resolveWith( elem, [ animation ] ); - return false; - }, - animation = deferred.promise( { - elem: elem, - props: jQuery.extend( {}, properties ), - opts: jQuery.extend( true, { - specialEasing: {}, - easing: jQuery.easing._default - }, options ), - originalProperties: properties, - originalOptions: options, - startTime: fxNow || createFxNow(), - duration: options.duration, - tweens: [], - createTween: function( prop, end ) { - var tween = jQuery.Tween( elem, animation.opts, prop, end, - animation.opts.specialEasing[ prop ] || animation.opts.easing ); - animation.tweens.push( tween ); - return tween; - }, - stop: function( gotoEnd ) { - var index = 0, - - // If we are going to the end, we want to run all the tweens - // otherwise we skip this part - length = gotoEnd ? animation.tweens.length : 0; - if ( stopped ) { - return this; - } - stopped = true; - for ( ; index < length; index++ ) { - animation.tweens[ index ].run( 1 ); - } - - // Resolve when we played the last frame; otherwise, reject - if ( gotoEnd ) { - deferred.notifyWith( elem, [ animation, 1, 0 ] ); - deferred.resolveWith( elem, [ animation, gotoEnd ] ); - } else { - deferred.rejectWith( elem, [ animation, gotoEnd ] ); - } - return this; - } - } ), - props = animation.props; - - propFilter( props, animation.opts.specialEasing ); - - for ( ; index < length; index++ ) { - result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); - if ( result ) { - if ( isFunction( result.stop ) ) { - jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = - result.stop.bind( result ); - } - return result; - } - } - - jQuery.map( props, createTween, animation ); - - if ( isFunction( animation.opts.start ) ) { - animation.opts.start.call( elem, animation ); - } - - // Attach callbacks from options - animation - .progress( animation.opts.progress ) - .done( animation.opts.done, animation.opts.complete ) - .fail( animation.opts.fail ) - .always( animation.opts.always ); - - jQuery.fx.timer( - jQuery.extend( tick, { - elem: elem, - anim: animation, - queue: animation.opts.queue - } ) - ); - - return animation; -} - -jQuery.Animation = jQuery.extend( Animation, { - - tweeners: { - "*": [ function( prop, value ) { - var tween = this.createTween( prop, value ); - adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); - return tween; - } ] - }, - - tweener: function( props, callback ) { - if ( isFunction( props ) ) { - callback = props; - props = [ "*" ]; - } else { - props = props.match( rnothtmlwhite ); - } - - var prop, - index = 0, - length = props.length; - - for ( ; index < length; index++ ) { - prop = props[ index ]; - Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; - Animation.tweeners[ prop ].unshift( callback ); - } - }, - - prefilters: [ defaultPrefilter ], - - prefilter: function( callback, prepend ) { - if ( prepend ) { - Animation.prefilters.unshift( callback ); - } else { - Animation.prefilters.push( callback ); - } - } -} ); - -jQuery.speed = function( speed, easing, fn ) { - var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { - complete: fn || !fn && easing || - isFunction( speed ) && speed, - duration: speed, - easing: fn && easing || easing && !isFunction( easing ) && easing - }; - - // Go to the end state if fx are off - if ( jQuery.fx.off ) { - opt.duration = 0; - - } else { - if ( typeof opt.duration !== "number" ) { - if ( opt.duration in jQuery.fx.speeds ) { - opt.duration = jQuery.fx.speeds[ opt.duration ]; - - } else { - opt.duration = jQuery.fx.speeds._default; - } - } - } - - // Normalize opt.queue - true/undefined/null -> "fx" - if ( opt.queue == null || opt.queue === true ) { - opt.queue = "fx"; - } - - // Queueing - opt.old = opt.complete; - - opt.complete = function() { - if ( isFunction( opt.old ) ) { - opt.old.call( this ); - } - - if ( opt.queue ) { - jQuery.dequeue( this, opt.queue ); - } - }; - - return opt; -}; - -jQuery.fn.extend( { - fadeTo: function( speed, to, easing, callback ) { - - // Show any hidden elements after setting opacity to 0 - return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() - - // Animate to the value specified - .end().animate( { opacity: to }, speed, easing, callback ); - }, - animate: function( prop, speed, easing, callback ) { - var empty = jQuery.isEmptyObject( prop ), - optall = jQuery.speed( speed, easing, callback ), - doAnimation = function() { - - // Operate on a copy of prop so per-property easing won't be lost - var anim = Animation( this, jQuery.extend( {}, prop ), optall ); - - // Empty animations, or finishing resolves immediately - if ( empty || dataPriv.get( this, "finish" ) ) { - anim.stop( true ); - } - }; - doAnimation.finish = doAnimation; - - return empty || optall.queue === false ? - this.each( doAnimation ) : - this.queue( optall.queue, doAnimation ); - }, - stop: function( type, clearQueue, gotoEnd ) { - var stopQueue = function( hooks ) { - var stop = hooks.stop; - delete hooks.stop; - stop( gotoEnd ); - }; - - if ( typeof type !== "string" ) { - gotoEnd = clearQueue; - clearQueue = type; - type = undefined; - } - if ( clearQueue && type !== false ) { - this.queue( type || "fx", [] ); - } - - return this.each( function() { - var dequeue = true, - index = type != null && type + "queueHooks", - timers = jQuery.timers, - data = dataPriv.get( this ); - - if ( index ) { - if ( data[ index ] && data[ index ].stop ) { - stopQueue( data[ index ] ); - } - } else { - for ( index in data ) { - if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { - stopQueue( data[ index ] ); - } - } - } - - for ( index = timers.length; index--; ) { - if ( timers[ index ].elem === this && - ( type == null || timers[ index ].queue === type ) ) { - - timers[ index ].anim.stop( gotoEnd ); - dequeue = false; - timers.splice( index, 1 ); - } - } - - // Start the next in the queue if the last step wasn't forced. - // Timers currently will call their complete callbacks, which - // will dequeue but only if they were gotoEnd. - if ( dequeue || !gotoEnd ) { - jQuery.dequeue( this, type ); - } - } ); - }, - finish: function( type ) { - if ( type !== false ) { - type = type || "fx"; - } - return this.each( function() { - var index, - data = dataPriv.get( this ), - queue = data[ type + "queue" ], - hooks = data[ type + "queueHooks" ], - timers = jQuery.timers, - length = queue ? queue.length : 0; - - // Enable finishing flag on private data - data.finish = true; - - // Empty the queue first - jQuery.queue( this, type, [] ); - - if ( hooks && hooks.stop ) { - hooks.stop.call( this, true ); - } - - // Look for any active animations, and finish them - for ( index = timers.length; index--; ) { - if ( timers[ index ].elem === this && timers[ index ].queue === type ) { - timers[ index ].anim.stop( true ); - timers.splice( index, 1 ); - } - } - - // Look for any animations in the old queue and finish them - for ( index = 0; index < length; index++ ) { - if ( queue[ index ] && queue[ index ].finish ) { - queue[ index ].finish.call( this ); - } - } - - // Turn off finishing flag - delete data.finish; - } ); - } -} ); - -jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) { - var cssFn = jQuery.fn[ name ]; - jQuery.fn[ name ] = function( speed, easing, callback ) { - return speed == null || typeof speed === "boolean" ? - cssFn.apply( this, arguments ) : - this.animate( genFx( name, true ), speed, easing, callback ); - }; -} ); - -// Generate shortcuts for custom animations -jQuery.each( { - slideDown: genFx( "show" ), - slideUp: genFx( "hide" ), - slideToggle: genFx( "toggle" ), - fadeIn: { opacity: "show" }, - fadeOut: { opacity: "hide" }, - fadeToggle: { opacity: "toggle" } -}, function( name, props ) { - jQuery.fn[ name ] = function( speed, easing, callback ) { - return this.animate( props, speed, easing, callback ); - }; -} ); - -jQuery.timers = []; -jQuery.fx.tick = function() { - var timer, - i = 0, - timers = jQuery.timers; - - fxNow = Date.now(); - - for ( ; i < timers.length; i++ ) { - timer = timers[ i ]; - - // Run the timer and safely remove it when done (allowing for external removal) - if ( !timer() && timers[ i ] === timer ) { - timers.splice( i--, 1 ); - } - } - - if ( !timers.length ) { - jQuery.fx.stop(); - } - fxNow = undefined; -}; - -jQuery.fx.timer = function( timer ) { - jQuery.timers.push( timer ); - jQuery.fx.start(); -}; - -jQuery.fx.interval = 13; -jQuery.fx.start = function() { - if ( inProgress ) { - return; - } - - inProgress = true; - schedule(); -}; - -jQuery.fx.stop = function() { - inProgress = null; -}; - -jQuery.fx.speeds = { - slow: 600, - fast: 200, - - // Default speed - _default: 400 -}; - - -// Based off of the plugin by Clint Helfers, with permission. -// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ -jQuery.fn.delay = function( time, type ) { - time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; - type = type || "fx"; - - return this.queue( type, function( next, hooks ) { - var timeout = window.setTimeout( next, time ); - hooks.stop = function() { - window.clearTimeout( timeout ); - }; - } ); -}; - - -( function() { - var input = document.createElement( "input" ), - select = document.createElement( "select" ), - opt = select.appendChild( document.createElement( "option" ) ); - - input.type = "checkbox"; - - // Support: Android <=4.3 only - // Default value for a checkbox should be "on" - support.checkOn = input.value !== ""; - - // Support: IE <=11 only - // Must access selectedIndex to make default options select - support.optSelected = opt.selected; - - // Support: IE <=11 only - // An input loses its value after becoming a radio - input = document.createElement( "input" ); - input.value = "t"; - input.type = "radio"; - support.radioValue = input.value === "t"; -} )(); - - -var boolHook, - attrHandle = jQuery.expr.attrHandle; - -jQuery.fn.extend( { - attr: function( name, value ) { - return access( this, jQuery.attr, name, value, arguments.length > 1 ); - }, - - removeAttr: function( name ) { - return this.each( function() { - jQuery.removeAttr( this, name ); - } ); - } -} ); - -jQuery.extend( { - attr: function( elem, name, value ) { - var ret, hooks, - nType = elem.nodeType; - - // Don't get/set attributes on text, comment and attribute nodes - if ( nType === 3 || nType === 8 || nType === 2 ) { - return; - } - - // Fallback to prop when attributes are not supported - if ( typeof elem.getAttribute === "undefined" ) { - return jQuery.prop( elem, name, value ); - } - - // Attribute hooks are determined by the lowercase version - // Grab necessary hook if one is defined - if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { - hooks = jQuery.attrHooks[ name.toLowerCase() ] || - ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); - } - - if ( value !== undefined ) { - if ( value === null ) { - jQuery.removeAttr( elem, name ); - return; - } - - if ( hooks && "set" in hooks && - ( ret = hooks.set( elem, value, name ) ) !== undefined ) { - return ret; - } - - elem.setAttribute( name, value + "" ); - return value; - } - - if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { - return ret; - } - - ret = jQuery.find.attr( elem, name ); - - // Non-existent attributes return null, we normalize to undefined - return ret == null ? undefined : ret; - }, - - attrHooks: { - type: { - set: function( elem, value ) { - if ( !support.radioValue && value === "radio" && - nodeName( elem, "input" ) ) { - var val = elem.value; - elem.setAttribute( "type", value ); - if ( val ) { - elem.value = val; - } - return value; - } - } - } - }, - - removeAttr: function( elem, value ) { - var name, - i = 0, - - // Attribute names can contain non-HTML whitespace characters - // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 - attrNames = value && value.match( rnothtmlwhite ); - - if ( attrNames && elem.nodeType === 1 ) { - while ( ( name = attrNames[ i++ ] ) ) { - elem.removeAttribute( name ); - } - } - } -} ); - -// Hooks for boolean attributes -boolHook = { - set: function( elem, value, name ) { - if ( value === false ) { - - // Remove boolean attributes when set to false - jQuery.removeAttr( elem, name ); - } else { - elem.setAttribute( name, name ); - } - return name; - } -}; - -jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { - var getter = attrHandle[ name ] || jQuery.find.attr; - - attrHandle[ name ] = function( elem, name, isXML ) { - var ret, handle, - lowercaseName = name.toLowerCase(); - - if ( !isXML ) { - - // Avoid an infinite loop by temporarily removing this function from the getter - handle = attrHandle[ lowercaseName ]; - attrHandle[ lowercaseName ] = ret; - ret = getter( elem, name, isXML ) != null ? - lowercaseName : - null; - attrHandle[ lowercaseName ] = handle; - } - return ret; - }; -} ); - - - - -var rfocusable = /^(?:input|select|textarea|button)$/i, - rclickable = /^(?:a|area)$/i; - -jQuery.fn.extend( { - prop: function( name, value ) { - return access( this, jQuery.prop, name, value, arguments.length > 1 ); - }, - - removeProp: function( name ) { - return this.each( function() { - delete this[ jQuery.propFix[ name ] || name ]; - } ); - } -} ); - -jQuery.extend( { - prop: function( elem, name, value ) { - var ret, hooks, - nType = elem.nodeType; - - // Don't get/set properties on text, comment and attribute nodes - if ( nType === 3 || nType === 8 || nType === 2 ) { - return; - } - - if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { - - // Fix name and attach hooks - name = jQuery.propFix[ name ] || name; - hooks = jQuery.propHooks[ name ]; - } - - if ( value !== undefined ) { - if ( hooks && "set" in hooks && - ( ret = hooks.set( elem, value, name ) ) !== undefined ) { - return ret; - } - - return ( elem[ name ] = value ); - } - - if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { - return ret; - } - - return elem[ name ]; - }, - - propHooks: { - tabIndex: { - get: function( elem ) { - - // Support: IE <=9 - 11 only - // elem.tabIndex doesn't always return the - // correct value when it hasn't been explicitly set - // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ - // Use proper attribute retrieval(#12072) - var tabindex = jQuery.find.attr( elem, "tabindex" ); - - if ( tabindex ) { - return parseInt( tabindex, 10 ); - } - - if ( - rfocusable.test( elem.nodeName ) || - rclickable.test( elem.nodeName ) && - elem.href - ) { - return 0; - } - - return -1; - } - } - }, - - propFix: { - "for": "htmlFor", - "class": "className" - } -} ); - -// Support: IE <=11 only -// Accessing the selectedIndex property -// forces the browser to respect setting selected -// on the option -// The getter ensures a default option is selected -// when in an optgroup -// eslint rule "no-unused-expressions" is disabled for this code -// since it considers such accessions noop -if ( !support.optSelected ) { - jQuery.propHooks.selected = { - get: function( elem ) { - - /* eslint no-unused-expressions: "off" */ - - var parent = elem.parentNode; - if ( parent && parent.parentNode ) { - parent.parentNode.selectedIndex; - } - return null; - }, - set: function( elem ) { - - /* eslint no-unused-expressions: "off" */ - - var parent = elem.parentNode; - if ( parent ) { - parent.selectedIndex; - - if ( parent.parentNode ) { - parent.parentNode.selectedIndex; - } - } - } - }; -} - -jQuery.each( [ - "tabIndex", - "readOnly", - "maxLength", - "cellSpacing", - "cellPadding", - "rowSpan", - "colSpan", - "useMap", - "frameBorder", - "contentEditable" -], function() { - jQuery.propFix[ this.toLowerCase() ] = this; -} ); - - - - - // Strip and collapse whitespace according to HTML spec - // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace - function stripAndCollapse( value ) { - var tokens = value.match( rnothtmlwhite ) || []; - return tokens.join( " " ); - } - - -function getClass( elem ) { - return elem.getAttribute && elem.getAttribute( "class" ) || ""; -} - -function classesToArray( value ) { - if ( Array.isArray( value ) ) { - return value; - } - if ( typeof value === "string" ) { - return value.match( rnothtmlwhite ) || []; - } - return []; -} - -jQuery.fn.extend( { - addClass: function( value ) { - var classes, elem, cur, curValue, clazz, j, finalValue, - i = 0; - - if ( isFunction( value ) ) { - return this.each( function( j ) { - jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); - } ); - } - - classes = classesToArray( value ); - - if ( classes.length ) { - while ( ( elem = this[ i++ ] ) ) { - curValue = getClass( elem ); - cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); - - if ( cur ) { - j = 0; - while ( ( clazz = classes[ j++ ] ) ) { - if ( cur.indexOf( " " + clazz + " " ) < 0 ) { - cur += clazz + " "; - } - } - - // Only assign if different to avoid unneeded rendering. - finalValue = stripAndCollapse( cur ); - if ( curValue !== finalValue ) { - elem.setAttribute( "class", finalValue ); - } - } - } - } - - return this; - }, - - removeClass: function( value ) { - var classes, elem, cur, curValue, clazz, j, finalValue, - i = 0; - - if ( isFunction( value ) ) { - return this.each( function( j ) { - jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); - } ); - } - - if ( !arguments.length ) { - return this.attr( "class", "" ); - } - - classes = classesToArray( value ); - - if ( classes.length ) { - while ( ( elem = this[ i++ ] ) ) { - curValue = getClass( elem ); - - // This expression is here for better compressibility (see addClass) - cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); - - if ( cur ) { - j = 0; - while ( ( clazz = classes[ j++ ] ) ) { - - // Remove *all* instances - while ( cur.indexOf( " " + clazz + " " ) > -1 ) { - cur = cur.replace( " " + clazz + " ", " " ); - } - } - - // Only assign if different to avoid unneeded rendering. - finalValue = stripAndCollapse( cur ); - if ( curValue !== finalValue ) { - elem.setAttribute( "class", finalValue ); - } - } - } - } - - return this; - }, - - toggleClass: function( value, stateVal ) { - var type = typeof value, - isValidValue = type === "string" || Array.isArray( value ); - - if ( typeof stateVal === "boolean" && isValidValue ) { - return stateVal ? this.addClass( value ) : this.removeClass( value ); - } - - if ( isFunction( value ) ) { - return this.each( function( i ) { - jQuery( this ).toggleClass( - value.call( this, i, getClass( this ), stateVal ), - stateVal - ); - } ); - } - - return this.each( function() { - var className, i, self, classNames; - - if ( isValidValue ) { - - // Toggle individual class names - i = 0; - self = jQuery( this ); - classNames = classesToArray( value ); - - while ( ( className = classNames[ i++ ] ) ) { - - // Check each className given, space separated list - if ( self.hasClass( className ) ) { - self.removeClass( className ); - } else { - self.addClass( className ); - } - } - - // Toggle whole class name - } else if ( value === undefined || type === "boolean" ) { - className = getClass( this ); - if ( className ) { - - // Store className if set - dataPriv.set( this, "__className__", className ); - } - - // If the element has a class name or if we're passed `false`, - // then remove the whole classname (if there was one, the above saved it). - // Otherwise bring back whatever was previously saved (if anything), - // falling back to the empty string if nothing was stored. - if ( this.setAttribute ) { - this.setAttribute( "class", - className || value === false ? - "" : - dataPriv.get( this, "__className__" ) || "" - ); - } - } - } ); - }, - - hasClass: function( selector ) { - var className, elem, - i = 0; - - className = " " + selector + " "; - while ( ( elem = this[ i++ ] ) ) { - if ( elem.nodeType === 1 && - ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { - return true; - } - } - - return false; - } -} ); - - - - -var rreturn = /\r/g; - -jQuery.fn.extend( { - val: function( value ) { - var hooks, ret, valueIsFunction, - elem = this[ 0 ]; - - if ( !arguments.length ) { - if ( elem ) { - hooks = jQuery.valHooks[ elem.type ] || - jQuery.valHooks[ elem.nodeName.toLowerCase() ]; - - if ( hooks && - "get" in hooks && - ( ret = hooks.get( elem, "value" ) ) !== undefined - ) { - return ret; - } - - ret = elem.value; - - // Handle most common string cases - if ( typeof ret === "string" ) { - return ret.replace( rreturn, "" ); - } - - // Handle cases where value is null/undef or number - return ret == null ? "" : ret; - } - - return; - } - - valueIsFunction = isFunction( value ); - - return this.each( function( i ) { - var val; - - if ( this.nodeType !== 1 ) { - return; - } - - if ( valueIsFunction ) { - val = value.call( this, i, jQuery( this ).val() ); - } else { - val = value; - } - - // Treat null/undefined as ""; convert numbers to string - if ( val == null ) { - val = ""; - - } else if ( typeof val === "number" ) { - val += ""; - - } else if ( Array.isArray( val ) ) { - val = jQuery.map( val, function( value ) { - return value == null ? "" : value + ""; - } ); - } - - hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; - - // If set returns undefined, fall back to normal setting - if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { - this.value = val; - } - } ); - } -} ); - -jQuery.extend( { - valHooks: { - option: { - get: function( elem ) { - - var val = jQuery.find.attr( elem, "value" ); - return val != null ? - val : - - // Support: IE <=10 - 11 only - // option.text throws exceptions (#14686, #14858) - // Strip and collapse whitespace - // https://html.spec.whatwg.org/#strip-and-collapse-whitespace - stripAndCollapse( jQuery.text( elem ) ); - } - }, - select: { - get: function( elem ) { - var value, option, i, - options = elem.options, - index = elem.selectedIndex, - one = elem.type === "select-one", - values = one ? null : [], - max = one ? index + 1 : options.length; - - if ( index < 0 ) { - i = max; - - } else { - i = one ? index : 0; - } - - // Loop through all the selected options - for ( ; i < max; i++ ) { - option = options[ i ]; - - // Support: IE <=9 only - // IE8-9 doesn't update selected after form reset (#2551) - if ( ( option.selected || i === index ) && - - // Don't return options that are disabled or in a disabled optgroup - !option.disabled && - ( !option.parentNode.disabled || - !nodeName( option.parentNode, "optgroup" ) ) ) { - - // Get the specific value for the option - value = jQuery( option ).val(); - - // We don't need an array for one selects - if ( one ) { - return value; - } - - // Multi-Selects return an array - values.push( value ); - } - } - - return values; - }, - - set: function( elem, value ) { - var optionSet, option, - options = elem.options, - values = jQuery.makeArray( value ), - i = options.length; - - while ( i-- ) { - option = options[ i ]; - - /* eslint-disable no-cond-assign */ - - if ( option.selected = - jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 - ) { - optionSet = true; - } - - /* eslint-enable no-cond-assign */ - } - - // Force browsers to behave consistently when non-matching value is set - if ( !optionSet ) { - elem.selectedIndex = -1; - } - return values; - } - } - } -} ); - -// Radios and checkboxes getter/setter -jQuery.each( [ "radio", "checkbox" ], function() { - jQuery.valHooks[ this ] = { - set: function( elem, value ) { - if ( Array.isArray( value ) ) { - return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); - } - } - }; - if ( !support.checkOn ) { - jQuery.valHooks[ this ].get = function( elem ) { - return elem.getAttribute( "value" ) === null ? "on" : elem.value; - }; - } -} ); - - - - -// Return jQuery for attributes-only inclusion - - -support.focusin = "onfocusin" in window; - - -var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, - stopPropagationCallback = function( e ) { - e.stopPropagation(); - }; - -jQuery.extend( jQuery.event, { - - trigger: function( event, data, elem, onlyHandlers ) { - - var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, - eventPath = [ elem || document ], - type = hasOwn.call( event, "type" ) ? event.type : event, - namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; - - cur = lastElement = tmp = elem = elem || document; - - // Don't do events on text and comment nodes - if ( elem.nodeType === 3 || elem.nodeType === 8 ) { - return; - } - - // focus/blur morphs to focusin/out; ensure we're not firing them right now - if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { - return; - } - - if ( type.indexOf( "." ) > -1 ) { - - // Namespaced trigger; create a regexp to match event type in handle() - namespaces = type.split( "." ); - type = namespaces.shift(); - namespaces.sort(); - } - ontype = type.indexOf( ":" ) < 0 && "on" + type; - - // Caller can pass in a jQuery.Event object, Object, or just an event type string - event = event[ jQuery.expando ] ? - event : - new jQuery.Event( type, typeof event === "object" && event ); - - // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) - event.isTrigger = onlyHandlers ? 2 : 3; - event.namespace = namespaces.join( "." ); - event.rnamespace = event.namespace ? - new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : - null; - - // Clean up the event in case it is being reused - event.result = undefined; - if ( !event.target ) { - event.target = elem; - } - - // Clone any incoming data and prepend the event, creating the handler arg list - data = data == null ? - [ event ] : - jQuery.makeArray( data, [ event ] ); - - // Allow special events to draw outside the lines - special = jQuery.event.special[ type ] || {}; - if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { - return; - } - - // Determine event propagation path in advance, per W3C events spec (#9951) - // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) - if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { - - bubbleType = special.delegateType || type; - if ( !rfocusMorph.test( bubbleType + type ) ) { - cur = cur.parentNode; - } - for ( ; cur; cur = cur.parentNode ) { - eventPath.push( cur ); - tmp = cur; - } - - // Only add window if we got to document (e.g., not plain obj or detached DOM) - if ( tmp === ( elem.ownerDocument || document ) ) { - eventPath.push( tmp.defaultView || tmp.parentWindow || window ); - } - } - - // Fire handlers on the event path - i = 0; - while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { - lastElement = cur; - event.type = i > 1 ? - bubbleType : - special.bindType || type; - - // jQuery handler - handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] && - dataPriv.get( cur, "handle" ); - if ( handle ) { - handle.apply( cur, data ); - } - - // Native handler - handle = ontype && cur[ ontype ]; - if ( handle && handle.apply && acceptData( cur ) ) { - event.result = handle.apply( cur, data ); - if ( event.result === false ) { - event.preventDefault(); - } - } - } - event.type = type; - - // If nobody prevented the default action, do it now - if ( !onlyHandlers && !event.isDefaultPrevented() ) { - - if ( ( !special._default || - special._default.apply( eventPath.pop(), data ) === false ) && - acceptData( elem ) ) { - - // Call a native DOM method on the target with the same name as the event. - // Don't do default actions on window, that's where global variables be (#6170) - if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { - - // Don't re-trigger an onFOO event when we call its FOO() method - tmp = elem[ ontype ]; - - if ( tmp ) { - elem[ ontype ] = null; - } - - // Prevent re-triggering of the same event, since we already bubbled it above - jQuery.event.triggered = type; - - if ( event.isPropagationStopped() ) { - lastElement.addEventListener( type, stopPropagationCallback ); - } - - elem[ type ](); - - if ( event.isPropagationStopped() ) { - lastElement.removeEventListener( type, stopPropagationCallback ); - } - - jQuery.event.triggered = undefined; - - if ( tmp ) { - elem[ ontype ] = tmp; - } - } - } - } - - return event.result; - }, - - // Piggyback on a donor event to simulate a different one - // Used only for `focus(in | out)` events - simulate: function( type, elem, event ) { - var e = jQuery.extend( - new jQuery.Event(), - event, - { - type: type, - isSimulated: true - } - ); - - jQuery.event.trigger( e, null, elem ); - } - -} ); - -jQuery.fn.extend( { - - trigger: function( type, data ) { - return this.each( function() { - jQuery.event.trigger( type, data, this ); - } ); - }, - triggerHandler: function( type, data ) { - var elem = this[ 0 ]; - if ( elem ) { - return jQuery.event.trigger( type, data, elem, true ); - } - } -} ); - - -// Support: Firefox <=44 -// Firefox doesn't have focus(in | out) events -// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 -// -// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 -// focus(in | out) events fire after focus & blur events, -// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order -// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 -if ( !support.focusin ) { - jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { - - // Attach a single capturing handler on the document while someone wants focusin/focusout - var handler = function( event ) { - jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); - }; - - jQuery.event.special[ fix ] = { - setup: function() { - var doc = this.ownerDocument || this, - attaches = dataPriv.access( doc, fix ); - - if ( !attaches ) { - doc.addEventListener( orig, handler, true ); - } - dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); - }, - teardown: function() { - var doc = this.ownerDocument || this, - attaches = dataPriv.access( doc, fix ) - 1; - - if ( !attaches ) { - doc.removeEventListener( orig, handler, true ); - dataPriv.remove( doc, fix ); - - } else { - dataPriv.access( doc, fix, attaches ); - } - } - }; - } ); -} -var location = window.location; - -var nonce = Date.now(); - -var rquery = ( /\?/ ); - - - -// Cross-browser xml parsing -jQuery.parseXML = function( data ) { - var xml; - if ( !data || typeof data !== "string" ) { - return null; - } - - // Support: IE 9 - 11 only - // IE throws on parseFromString with invalid input. - try { - xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); - } catch ( e ) { - xml = undefined; - } - - if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { - jQuery.error( "Invalid XML: " + data ); - } - return xml; -}; - - -var - rbracket = /\[\]$/, - rCRLF = /\r?\n/g, - rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, - rsubmittable = /^(?:input|select|textarea|keygen)/i; - -function buildParams( prefix, obj, traditional, add ) { - var name; - - if ( Array.isArray( obj ) ) { - - // Serialize array item. - jQuery.each( obj, function( i, v ) { - if ( traditional || rbracket.test( prefix ) ) { - - // Treat each array item as a scalar. - add( prefix, v ); - - } else { - - // Item is non-scalar (array or object), encode its numeric index. - buildParams( - prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", - v, - traditional, - add - ); - } - } ); - - } else if ( !traditional && toType( obj ) === "object" ) { - - // Serialize object item. - for ( name in obj ) { - buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); - } - - } else { - - // Serialize scalar item. - add( prefix, obj ); - } -} - -// Serialize an array of form elements or a set of -// key/values into a query string -jQuery.param = function( a, traditional ) { - var prefix, - s = [], - add = function( key, valueOrFunction ) { - - // If value is a function, invoke it and use its return value - var value = isFunction( valueOrFunction ) ? - valueOrFunction() : - valueOrFunction; - - s[ s.length ] = encodeURIComponent( key ) + "=" + - encodeURIComponent( value == null ? "" : value ); - }; - - if ( a == null ) { - return ""; - } - - // If an array was passed in, assume that it is an array of form elements. - if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { - - // Serialize the form elements - jQuery.each( a, function() { - add( this.name, this.value ); - } ); - - } else { - - // If traditional, encode the "old" way (the way 1.3.2 or older - // did it), otherwise encode params recursively. - for ( prefix in a ) { - buildParams( prefix, a[ prefix ], traditional, add ); - } - } - - // Return the resulting serialization - return s.join( "&" ); -}; - -jQuery.fn.extend( { - serialize: function() { - return jQuery.param( this.serializeArray() ); - }, - serializeArray: function() { - return this.map( function() { - - // Can add propHook for "elements" to filter or add form elements - var elements = jQuery.prop( this, "elements" ); - return elements ? jQuery.makeArray( elements ) : this; - } ) - .filter( function() { - var type = this.type; - - // Use .is( ":disabled" ) so that fieldset[disabled] works - return this.name && !jQuery( this ).is( ":disabled" ) && - rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && - ( this.checked || !rcheckableType.test( type ) ); - } ) - .map( function( i, elem ) { - var val = jQuery( this ).val(); - - if ( val == null ) { - return null; - } - - if ( Array.isArray( val ) ) { - return jQuery.map( val, function( val ) { - return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; - } ); - } - - return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; - } ).get(); - } -} ); - - -var - r20 = /%20/g, - rhash = /#.*$/, - rantiCache = /([?&])_=[^&]*/, - rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, - - // #7653, #8125, #8152: local protocol detection - rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, - rnoContent = /^(?:GET|HEAD)$/, - rprotocol = /^\/\//, - - /* Prefilters - * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) - * 2) These are called: - * - BEFORE asking for a transport - * - AFTER param serialization (s.data is a string if s.processData is true) - * 3) key is the dataType - * 4) the catchall symbol "*" can be used - * 5) execution will start with transport dataType and THEN continue down to "*" if needed - */ - prefilters = {}, - - /* Transports bindings - * 1) key is the dataType - * 2) the catchall symbol "*" can be used - * 3) selection will start with transport dataType and THEN go to "*" if needed - */ - transports = {}, - - // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression - allTypes = "*/".concat( "*" ), - - // Anchor tag for parsing the document origin - originAnchor = document.createElement( "a" ); - originAnchor.href = location.href; - -// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport -function addToPrefiltersOrTransports( structure ) { - - // dataTypeExpression is optional and defaults to "*" - return function( dataTypeExpression, func ) { - - if ( typeof dataTypeExpression !== "string" ) { - func = dataTypeExpression; - dataTypeExpression = "*"; - } - - var dataType, - i = 0, - dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; - - if ( isFunction( func ) ) { - - // For each dataType in the dataTypeExpression - while ( ( dataType = dataTypes[ i++ ] ) ) { - - // Prepend if requested - if ( dataType[ 0 ] === "+" ) { - dataType = dataType.slice( 1 ) || "*"; - ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); - - // Otherwise append - } else { - ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); - } - } - } - }; -} - -// Base inspection function for prefilters and transports -function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { - - var inspected = {}, - seekingTransport = ( structure === transports ); - - function inspect( dataType ) { - var selected; - inspected[ dataType ] = true; - jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { - var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); - if ( typeof dataTypeOrTransport === "string" && - !seekingTransport && !inspected[ dataTypeOrTransport ] ) { - - options.dataTypes.unshift( dataTypeOrTransport ); - inspect( dataTypeOrTransport ); - return false; - } else if ( seekingTransport ) { - return !( selected = dataTypeOrTransport ); - } - } ); - return selected; - } - - return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); -} - -// A special extend for ajax options -// that takes "flat" options (not to be deep extended) -// Fixes #9887 -function ajaxExtend( target, src ) { - var key, deep, - flatOptions = jQuery.ajaxSettings.flatOptions || {}; - - for ( key in src ) { - if ( src[ key ] !== undefined ) { - ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; - } - } - if ( deep ) { - jQuery.extend( true, target, deep ); - } - - return target; -} - -/* Handles responses to an ajax request: - * - finds the right dataType (mediates between content-type and expected dataType) - * - returns the corresponding response - */ -function ajaxHandleResponses( s, jqXHR, responses ) { - - var ct, type, finalDataType, firstDataType, - contents = s.contents, - dataTypes = s.dataTypes; - - // Remove auto dataType and get content-type in the process - while ( dataTypes[ 0 ] === "*" ) { - dataTypes.shift(); - if ( ct === undefined ) { - ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); - } - } - - // Check if we're dealing with a known content-type - if ( ct ) { - for ( type in contents ) { - if ( contents[ type ] && contents[ type ].test( ct ) ) { - dataTypes.unshift( type ); - break; - } - } - } - - // Check to see if we have a response for the expected dataType - if ( dataTypes[ 0 ] in responses ) { - finalDataType = dataTypes[ 0 ]; - } else { - - // Try convertible dataTypes - for ( type in responses ) { - if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { - finalDataType = type; - break; - } - if ( !firstDataType ) { - firstDataType = type; - } - } - - // Or just use first one - finalDataType = finalDataType || firstDataType; - } - - // If we found a dataType - // We add the dataType to the list if needed - // and return the corresponding response - if ( finalDataType ) { - if ( finalDataType !== dataTypes[ 0 ] ) { - dataTypes.unshift( finalDataType ); - } - return responses[ finalDataType ]; - } -} - -/* Chain conversions given the request and the original response - * Also sets the responseXXX fields on the jqXHR instance - */ -function ajaxConvert( s, response, jqXHR, isSuccess ) { - var conv2, current, conv, tmp, prev, - converters = {}, - - // Work with a copy of dataTypes in case we need to modify it for conversion - dataTypes = s.dataTypes.slice(); - - // Create converters map with lowercased keys - if ( dataTypes[ 1 ] ) { - for ( conv in s.converters ) { - converters[ conv.toLowerCase() ] = s.converters[ conv ]; - } - } - - current = dataTypes.shift(); - - // Convert to each sequential dataType - while ( current ) { - - if ( s.responseFields[ current ] ) { - jqXHR[ s.responseFields[ current ] ] = response; - } - - // Apply the dataFilter if provided - if ( !prev && isSuccess && s.dataFilter ) { - response = s.dataFilter( response, s.dataType ); - } - - prev = current; - current = dataTypes.shift(); - - if ( current ) { - - // There's only work to do if current dataType is non-auto - if ( current === "*" ) { - - current = prev; - - // Convert response if prev dataType is non-auto and differs from current - } else if ( prev !== "*" && prev !== current ) { - - // Seek a direct converter - conv = converters[ prev + " " + current ] || converters[ "* " + current ]; - - // If none found, seek a pair - if ( !conv ) { - for ( conv2 in converters ) { - - // If conv2 outputs current - tmp = conv2.split( " " ); - if ( tmp[ 1 ] === current ) { - - // If prev can be converted to accepted input - conv = converters[ prev + " " + tmp[ 0 ] ] || - converters[ "* " + tmp[ 0 ] ]; - if ( conv ) { - - // Condense equivalence converters - if ( conv === true ) { - conv = converters[ conv2 ]; - - // Otherwise, insert the intermediate dataType - } else if ( converters[ conv2 ] !== true ) { - current = tmp[ 0 ]; - dataTypes.unshift( tmp[ 1 ] ); - } - break; - } - } - } - } - - // Apply converter (if not an equivalence) - if ( conv !== true ) { - - // Unless errors are allowed to bubble, catch and return them - if ( conv && s.throws ) { - response = conv( response ); - } else { - try { - response = conv( response ); - } catch ( e ) { - return { - state: "parsererror", - error: conv ? e : "No conversion from " + prev + " to " + current - }; - } - } - } - } - } - } - - return { state: "success", data: response }; -} - -jQuery.extend( { - - // Counter for holding the number of active queries - active: 0, - - // Last-Modified header cache for next request - lastModified: {}, - etag: {}, - - ajaxSettings: { - url: location.href, - type: "GET", - isLocal: rlocalProtocol.test( location.protocol ), - global: true, - processData: true, - async: true, - contentType: "application/x-www-form-urlencoded; charset=UTF-8", - - /* - timeout: 0, - data: null, - dataType: null, - username: null, - password: null, - cache: null, - throws: false, - traditional: false, - headers: {}, - */ - - accepts: { - "*": allTypes, - text: "text/plain", - html: "text/html", - xml: "application/xml, text/xml", - json: "application/json, text/javascript" - }, - - contents: { - xml: /\bxml\b/, - html: /\bhtml/, - json: /\bjson\b/ - }, - - responseFields: { - xml: "responseXML", - text: "responseText", - json: "responseJSON" - }, - - // Data converters - // Keys separate source (or catchall "*") and destination types with a single space - converters: { - - // Convert anything to text - "* text": String, - - // Text to html (true = no transformation) - "text html": true, - - // Evaluate text as a json expression - "text json": JSON.parse, - - // Parse text as xml - "text xml": jQuery.parseXML - }, - - // For options that shouldn't be deep extended: - // you can add your own custom options here if - // and when you create one that shouldn't be - // deep extended (see ajaxExtend) - flatOptions: { - url: true, - context: true - } - }, - - // Creates a full fledged settings object into target - // with both ajaxSettings and settings fields. - // If target is omitted, writes into ajaxSettings. - ajaxSetup: function( target, settings ) { - return settings ? - - // Building a settings object - ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : - - // Extending ajaxSettings - ajaxExtend( jQuery.ajaxSettings, target ); - }, - - ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), - ajaxTransport: addToPrefiltersOrTransports( transports ), - - // Main method - ajax: function( url, options ) { - - // If url is an object, simulate pre-1.5 signature - if ( typeof url === "object" ) { - options = url; - url = undefined; - } - - // Force options to be an object - options = options || {}; - - var transport, - - // URL without anti-cache param - cacheURL, - - // Response headers - responseHeadersString, - responseHeaders, - - // timeout handle - timeoutTimer, - - // Url cleanup var - urlAnchor, - - // Request state (becomes false upon send and true upon completion) - completed, - - // To know if global events are to be dispatched - fireGlobals, - - // Loop variable - i, - - // uncached part of the url - uncached, - - // Create the final options object - s = jQuery.ajaxSetup( {}, options ), - - // Callbacks context - callbackContext = s.context || s, - - // Context for global events is callbackContext if it is a DOM node or jQuery collection - globalEventContext = s.context && - ( callbackContext.nodeType || callbackContext.jquery ) ? - jQuery( callbackContext ) : - jQuery.event, - - // Deferreds - deferred = jQuery.Deferred(), - completeDeferred = jQuery.Callbacks( "once memory" ), - - // Status-dependent callbacks - statusCode = s.statusCode || {}, - - // Headers (they are sent all at once) - requestHeaders = {}, - requestHeadersNames = {}, - - // Default abort message - strAbort = "canceled", - - // Fake xhr - jqXHR = { - readyState: 0, - - // Builds headers hashtable if needed - getResponseHeader: function( key ) { - var match; - if ( completed ) { - if ( !responseHeaders ) { - responseHeaders = {}; - while ( ( match = rheaders.exec( responseHeadersString ) ) ) { - responseHeaders[ match[ 1 ].toLowerCase() + " " ] = - ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) - .concat( match[ 2 ] ); - } - } - match = responseHeaders[ key.toLowerCase() + " " ]; - } - return match == null ? null : match.join( ", " ); - }, - - // Raw string - getAllResponseHeaders: function() { - return completed ? responseHeadersString : null; - }, - - // Caches the header - setRequestHeader: function( name, value ) { - if ( completed == null ) { - name = requestHeadersNames[ name.toLowerCase() ] = - requestHeadersNames[ name.toLowerCase() ] || name; - requestHeaders[ name ] = value; - } - return this; - }, - - // Overrides response content-type header - overrideMimeType: function( type ) { - if ( completed == null ) { - s.mimeType = type; - } - return this; - }, - - // Status-dependent callbacks - statusCode: function( map ) { - var code; - if ( map ) { - if ( completed ) { - - // Execute the appropriate callbacks - jqXHR.always( map[ jqXHR.status ] ); - } else { - - // Lazy-add the new callbacks in a way that preserves old ones - for ( code in map ) { - statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; - } - } - } - return this; - }, - - // Cancel the request - abort: function( statusText ) { - var finalText = statusText || strAbort; - if ( transport ) { - transport.abort( finalText ); - } - done( 0, finalText ); - return this; - } - }; - - // Attach deferreds - deferred.promise( jqXHR ); - - // Add protocol if not provided (prefilters might expect it) - // Handle falsy url in the settings object (#10093: consistency with old signature) - // We also use the url parameter if available - s.url = ( ( url || s.url || location.href ) + "" ) - .replace( rprotocol, location.protocol + "//" ); - - // Alias method option to type as per ticket #12004 - s.type = options.method || options.type || s.method || s.type; - - // Extract dataTypes list - s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; - - // A cross-domain request is in order when the origin doesn't match the current origin. - if ( s.crossDomain == null ) { - urlAnchor = document.createElement( "a" ); - - // Support: IE <=8 - 11, Edge 12 - 15 - // IE throws exception on accessing the href property if url is malformed, - // e.g. http://example.com:80x/ - try { - urlAnchor.href = s.url; - - // Support: IE <=8 - 11 only - // Anchor's host property isn't correctly set when s.url is relative - urlAnchor.href = urlAnchor.href; - s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== - urlAnchor.protocol + "//" + urlAnchor.host; - } catch ( e ) { - - // If there is an error parsing the URL, assume it is crossDomain, - // it can be rejected by the transport if it is invalid - s.crossDomain = true; - } - } - - // Convert data if not already a string - if ( s.data && s.processData && typeof s.data !== "string" ) { - s.data = jQuery.param( s.data, s.traditional ); - } - - // Apply prefilters - inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); - - // If request was aborted inside a prefilter, stop there - if ( completed ) { - return jqXHR; - } - - // We can fire global events as of now if asked to - // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) - fireGlobals = jQuery.event && s.global; - - // Watch for a new set of requests - if ( fireGlobals && jQuery.active++ === 0 ) { - jQuery.event.trigger( "ajaxStart" ); - } - - // Uppercase the type - s.type = s.type.toUpperCase(); - - // Determine if request has content - s.hasContent = !rnoContent.test( s.type ); - - // Save the URL in case we're toying with the If-Modified-Since - // and/or If-None-Match header later on - // Remove hash to simplify url manipulation - cacheURL = s.url.replace( rhash, "" ); - - // More options handling for requests with no content - if ( !s.hasContent ) { - - // Remember the hash so we can put it back - uncached = s.url.slice( cacheURL.length ); - - // If data is available and should be processed, append data to url - if ( s.data && ( s.processData || typeof s.data === "string" ) ) { - cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; - - // #9682: remove data so that it's not used in an eventual retry - delete s.data; - } - - // Add or update anti-cache param if needed - if ( s.cache === false ) { - cacheURL = cacheURL.replace( rantiCache, "$1" ); - uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached; - } - - // Put hash and anti-cache on the URL that will be requested (gh-1732) - s.url = cacheURL + uncached; - - // Change '%20' to '+' if this is encoded form body content (gh-2658) - } else if ( s.data && s.processData && - ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { - s.data = s.data.replace( r20, "+" ); - } - - // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. - if ( s.ifModified ) { - if ( jQuery.lastModified[ cacheURL ] ) { - jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); - } - if ( jQuery.etag[ cacheURL ] ) { - jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); - } - } - - // Set the correct header, if data is being sent - if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { - jqXHR.setRequestHeader( "Content-Type", s.contentType ); - } - - // Set the Accepts header for the server, depending on the dataType - jqXHR.setRequestHeader( - "Accept", - s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? - s.accepts[ s.dataTypes[ 0 ] ] + - ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : - s.accepts[ "*" ] - ); - - // Check for headers option - for ( i in s.headers ) { - jqXHR.setRequestHeader( i, s.headers[ i ] ); - } - - // Allow custom headers/mimetypes and early abort - if ( s.beforeSend && - ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { - - // Abort if not done already and return - return jqXHR.abort(); - } - - // Aborting is no longer a cancellation - strAbort = "abort"; - - // Install callbacks on deferreds - completeDeferred.add( s.complete ); - jqXHR.done( s.success ); - jqXHR.fail( s.error ); - - // Get transport - transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); - - // If no transport, we auto-abort - if ( !transport ) { - done( -1, "No Transport" ); - } else { - jqXHR.readyState = 1; - - // Send global event - if ( fireGlobals ) { - globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); - } - - // If request was aborted inside ajaxSend, stop there - if ( completed ) { - return jqXHR; - } - - // Timeout - if ( s.async && s.timeout > 0 ) { - timeoutTimer = window.setTimeout( function() { - jqXHR.abort( "timeout" ); - }, s.timeout ); - } - - try { - completed = false; - transport.send( requestHeaders, done ); - } catch ( e ) { - - // Rethrow post-completion exceptions - if ( completed ) { - throw e; - } - - // Propagate others as results - done( -1, e ); - } - } - - // Callback for when everything is done - function done( status, nativeStatusText, responses, headers ) { - var isSuccess, success, error, response, modified, - statusText = nativeStatusText; - - // Ignore repeat invocations - if ( completed ) { - return; - } - - completed = true; - - // Clear timeout if it exists - if ( timeoutTimer ) { - window.clearTimeout( timeoutTimer ); - } - - // Dereference transport for early garbage collection - // (no matter how long the jqXHR object will be used) - transport = undefined; - - // Cache response headers - responseHeadersString = headers || ""; - - // Set readyState - jqXHR.readyState = status > 0 ? 4 : 0; - - // Determine if successful - isSuccess = status >= 200 && status < 300 || status === 304; - - // Get response data - if ( responses ) { - response = ajaxHandleResponses( s, jqXHR, responses ); - } - - // Convert no matter what (that way responseXXX fields are always set) - response = ajaxConvert( s, response, jqXHR, isSuccess ); - - // If successful, handle type chaining - if ( isSuccess ) { - - // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. - if ( s.ifModified ) { - modified = jqXHR.getResponseHeader( "Last-Modified" ); - if ( modified ) { - jQuery.lastModified[ cacheURL ] = modified; - } - modified = jqXHR.getResponseHeader( "etag" ); - if ( modified ) { - jQuery.etag[ cacheURL ] = modified; - } - } - - // if no content - if ( status === 204 || s.type === "HEAD" ) { - statusText = "nocontent"; - - // if not modified - } else if ( status === 304 ) { - statusText = "notmodified"; - - // If we have data, let's convert it - } else { - statusText = response.state; - success = response.data; - error = response.error; - isSuccess = !error; - } - } else { - - // Extract error from statusText and normalize for non-aborts - error = statusText; - if ( status || !statusText ) { - statusText = "error"; - if ( status < 0 ) { - status = 0; - } - } - } - - // Set data for the fake xhr object - jqXHR.status = status; - jqXHR.statusText = ( nativeStatusText || statusText ) + ""; - - // Success/Error - if ( isSuccess ) { - deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); - } else { - deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); - } - - // Status-dependent callbacks - jqXHR.statusCode( statusCode ); - statusCode = undefined; - - if ( fireGlobals ) { - globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", - [ jqXHR, s, isSuccess ? success : error ] ); - } - - // Complete - completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); - - if ( fireGlobals ) { - globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); - - // Handle the global AJAX counter - if ( !( --jQuery.active ) ) { - jQuery.event.trigger( "ajaxStop" ); - } - } - } - - return jqXHR; - }, - - getJSON: function( url, data, callback ) { - return jQuery.get( url, data, callback, "json" ); - }, - - getScript: function( url, callback ) { - return jQuery.get( url, undefined, callback, "script" ); - } -} ); - -jQuery.each( [ "get", "post" ], function( i, method ) { - jQuery[ method ] = function( url, data, callback, type ) { - - // Shift arguments if data argument was omitted - if ( isFunction( data ) ) { - type = type || callback; - callback = data; - data = undefined; - } - - // The url can be an options object (which then must have .url) - return jQuery.ajax( jQuery.extend( { - url: url, - type: method, - dataType: type, - data: data, - success: callback - }, jQuery.isPlainObject( url ) && url ) ); - }; -} ); - - -jQuery._evalUrl = function( url, options ) { - return jQuery.ajax( { - url: url, - - // Make this explicit, since user can override this through ajaxSetup (#11264) - type: "GET", - dataType: "script", - cache: true, - async: false, - global: false, - - // Only evaluate the response if it is successful (gh-4126) - // dataFilter is not invoked for failure responses, so using it instead - // of the default converter is kludgy but it works. - converters: { - "text script": function() {} - }, - dataFilter: function( response ) { - jQuery.globalEval( response, options ); - } - } ); -}; - - -jQuery.fn.extend( { - wrapAll: function( html ) { - var wrap; - - if ( this[ 0 ] ) { - if ( isFunction( html ) ) { - html = html.call( this[ 0 ] ); - } - - // The elements to wrap the target around - wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); - - if ( this[ 0 ].parentNode ) { - wrap.insertBefore( this[ 0 ] ); - } - - wrap.map( function() { - var elem = this; - - while ( elem.firstElementChild ) { - elem = elem.firstElementChild; - } - - return elem; - } ).append( this ); - } - - return this; - }, - - wrapInner: function( html ) { - if ( isFunction( html ) ) { - return this.each( function( i ) { - jQuery( this ).wrapInner( html.call( this, i ) ); - } ); - } - - return this.each( function() { - var self = jQuery( this ), - contents = self.contents(); - - if ( contents.length ) { - contents.wrapAll( html ); - - } else { - self.append( html ); - } - } ); - }, - - wrap: function( html ) { - var htmlIsFunction = isFunction( html ); - - return this.each( function( i ) { - jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); - } ); - }, - - unwrap: function( selector ) { - this.parent( selector ).not( "body" ).each( function() { - jQuery( this ).replaceWith( this.childNodes ); - } ); - return this; - } -} ); - - -jQuery.expr.pseudos.hidden = function( elem ) { - return !jQuery.expr.pseudos.visible( elem ); -}; -jQuery.expr.pseudos.visible = function( elem ) { - return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); -}; - - - - -jQuery.ajaxSettings.xhr = function() { - try { - return new window.XMLHttpRequest(); - } catch ( e ) {} -}; - -var xhrSuccessStatus = { - - // File protocol always yields status code 0, assume 200 - 0: 200, - - // Support: IE <=9 only - // #1450: sometimes IE returns 1223 when it should be 204 - 1223: 204 - }, - xhrSupported = jQuery.ajaxSettings.xhr(); - -support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); -support.ajax = xhrSupported = !!xhrSupported; - -jQuery.ajaxTransport( function( options ) { - var callback, errorCallback; - - // Cross domain only allowed if supported through XMLHttpRequest - if ( support.cors || xhrSupported && !options.crossDomain ) { - return { - send: function( headers, complete ) { - var i, - xhr = options.xhr(); - - xhr.open( - options.type, - options.url, - options.async, - options.username, - options.password - ); - - // Apply custom fields if provided - if ( options.xhrFields ) { - for ( i in options.xhrFields ) { - xhr[ i ] = options.xhrFields[ i ]; - } - } - - // Override mime type if needed - if ( options.mimeType && xhr.overrideMimeType ) { - xhr.overrideMimeType( options.mimeType ); - } - - // X-Requested-With header - // For cross-domain requests, seeing as conditions for a preflight are - // akin to a jigsaw puzzle, we simply never set it to be sure. - // (it can always be set on a per-request basis or even using ajaxSetup) - // For same-domain requests, won't change header if already provided. - if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { - headers[ "X-Requested-With" ] = "XMLHttpRequest"; - } - - // Set headers - for ( i in headers ) { - xhr.setRequestHeader( i, headers[ i ] ); - } - - // Callback - callback = function( type ) { - return function() { - if ( callback ) { - callback = errorCallback = xhr.onload = - xhr.onerror = xhr.onabort = xhr.ontimeout = - xhr.onreadystatechange = null; - - if ( type === "abort" ) { - xhr.abort(); - } else if ( type === "error" ) { - - // Support: IE <=9 only - // On a manual native abort, IE9 throws - // errors on any property access that is not readyState - if ( typeof xhr.status !== "number" ) { - complete( 0, "error" ); - } else { - complete( - - // File: protocol always yields status 0; see #8605, #14207 - xhr.status, - xhr.statusText - ); - } - } else { - complete( - xhrSuccessStatus[ xhr.status ] || xhr.status, - xhr.statusText, - - // Support: IE <=9 only - // IE9 has no XHR2 but throws on binary (trac-11426) - // For XHR2 non-text, let the caller handle it (gh-2498) - ( xhr.responseType || "text" ) !== "text" || - typeof xhr.responseText !== "string" ? - { binary: xhr.response } : - { text: xhr.responseText }, - xhr.getAllResponseHeaders() - ); - } - } - }; - }; - - // Listen to events - xhr.onload = callback(); - errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); - - // Support: IE 9 only - // Use onreadystatechange to replace onabort - // to handle uncaught aborts - if ( xhr.onabort !== undefined ) { - xhr.onabort = errorCallback; - } else { - xhr.onreadystatechange = function() { - - // Check readyState before timeout as it changes - if ( xhr.readyState === 4 ) { - - // Allow onerror to be called first, - // but that will not handle a native abort - // Also, save errorCallback to a variable - // as xhr.onerror cannot be accessed - window.setTimeout( function() { - if ( callback ) { - errorCallback(); - } - } ); - } - }; - } - - // Create the abort callback - callback = callback( "abort" ); - - try { - - // Do send the request (this may raise an exception) - xhr.send( options.hasContent && options.data || null ); - } catch ( e ) { - - // #14683: Only rethrow if this hasn't been notified as an error yet - if ( callback ) { - throw e; - } - } - }, - - abort: function() { - if ( callback ) { - callback(); - } - } - }; - } -} ); - - - - -// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) -jQuery.ajaxPrefilter( function( s ) { - if ( s.crossDomain ) { - s.contents.script = false; - } -} ); - -// Install script dataType -jQuery.ajaxSetup( { - accepts: { - script: "text/javascript, application/javascript, " + - "application/ecmascript, application/x-ecmascript" - }, - contents: { - script: /\b(?:java|ecma)script\b/ - }, - converters: { - "text script": function( text ) { - jQuery.globalEval( text ); - return text; - } - } -} ); - -// Handle cache's special case and crossDomain -jQuery.ajaxPrefilter( "script", function( s ) { - if ( s.cache === undefined ) { - s.cache = false; - } - if ( s.crossDomain ) { - s.type = "GET"; - } -} ); - -// Bind script tag hack transport -jQuery.ajaxTransport( "script", function( s ) { - - // This transport only deals with cross domain or forced-by-attrs requests - if ( s.crossDomain || s.scriptAttrs ) { - var script, callback; - return { - send: function( _, complete ) { - script = jQuery( " - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

BSAInvalidationĀ¶

-
-
-class mobase.BSAInvalidationĀ¶
-

Bases: abc.ABC

-

Methods Summary

- ---- - - - - - - - - - - - -

activate(profile)

deactivate(profile)

isInvalidationBSA(name)

-
rtype
-

bool

-
-
-

-

Methods Documentation

-
-
-abstract activate(profile)Ā¶
-
- -
-
-abstract deactivate(profile)Ā¶
-
- -
-
-abstract isInvalidationBSA(name)Ā¶
-
-
Return type
-

bool

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.DataArchives.html b/gh-pages/api/mobase.DataArchives.html deleted file mode 100644 index 4c4cb74..0000000 --- a/gh-pages/api/mobase.DataArchives.html +++ /dev/null @@ -1,410 +0,0 @@ - - - - - - - - - - DataArchives — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

DataArchivesĀ¶

-
-
-class mobase.DataArchivesĀ¶
-

Bases: abc.ABC

-

Methods Summary

- ---- - - - - - - - - - - - - - - -

addArchive(profile,Ā index,Ā name)

Add an archive to the archive list.

archives(profile)

Retrieve the list of archives in the given profile.

removeArchive(profile,Ā name)

Remove the given archive from the given profile.

vanillaArchives()

Retrieve the list of vanilla archives.

-

Methods Documentation

-
-
-abstract addArchive(profile, index, name)Ā¶
-

Add an archive to the archive list.

-
-
Parameters
-
    -

  • profile ā€“ Profile to add the archive to.

    • -

  • index ā€“ Index to insert before. Use 0 for the beginning of the list or INT_MAX for the end of the list).

    • -

  • name ā€“ Name of the archive to add.

    • -
-
-
-
- -
-
-abstract archives(profile)Ā¶
-

Retrieve the list of archives in the given profile.

-
-
Parameters
-

profile ā€“ Profile to retrieve archives from.

-
-
Returns
-

The list of archives in the given profile.

-
-
Return type
-

List[str]

-
-
-
- -
-
-abstract removeArchive(profile, name)Ā¶
-

Remove the given archive from the given profile.

-
-
Parameters
-
    -

  • profile ā€“ Profile to remove the archive from.

    • -

  • name ā€“ Name of the archive to remove.

    • -
-
-
-
- -
-
-abstract vanillaArchives()Ā¶
-

Retrieve the list of vanilla archives.

-

Vanilla archives are archive files that are shipped with the original -game.

-
-
Returns
-

The list of vanilla archives.

-
-
Return type
-

List[str]

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.ExecutableForcedLoadSetting.html b/gh-pages/api/mobase.ExecutableForcedLoadSetting.html deleted file mode 100644 index 8fafb27..0000000 --- a/gh-pages/api/mobase.ExecutableForcedLoadSetting.html +++ /dev/null @@ -1,444 +0,0 @@ - - - - - - - - - - ExecutableForcedLoadSetting — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ExecutableForcedLoadSettingĀ¶

-
-
-class mobase.ExecutableForcedLoadSetting(process, library)Ā¶
-

Bases: object

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - -

enabled()

-
rtype
-

bool

-
-
-

forced()

-
rtype
-

bool

-
-
-

library()

-
rtype
-

str

-
-
-

process()

-
rtype
-

str

-
-
-

withEnabled(enabled)

-
rtype
-

ExecutableForcedLoadSetting

-
-
-

withForced(forced)

-
rtype
-

ExecutableForcedLoadSetting

-
-
-

-

Methods Documentation

-
-
-enabled()Ā¶
-
-
Return type
-

bool

-
-
-
- -
-
-forced()Ā¶
-
-
Return type
-

bool

-
-
-
- -
-
-library()Ā¶
-
-
Return type
-

str

-
-
-
- -
-
-process()Ā¶
-
-
Return type
-

str

-
-
-
- -
-
-withEnabled(enabled)Ā¶
-
-
Return type
-

ExecutableForcedLoadSetting

-
-
-
- -
-
-withForced(forced)Ā¶
-
-
Return type
-

ExecutableForcedLoadSetting

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.ExecutableInfo.html b/gh-pages/api/mobase.ExecutableInfo.html deleted file mode 100644 index cb3584a..0000000 --- a/gh-pages/api/mobase.ExecutableInfo.html +++ /dev/null @@ -1,534 +0,0 @@ - - - - - - - - - - ExecutableInfo — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ExecutableInfoĀ¶

-
-
-class mobase.ExecutableInfo(title, binary)Ā¶
-

Bases: object

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

arguments()

-
rtype
-

List[str]

-
-
-

asCustom()

-
rtype
-

ExecutableInfo

-
-
-

binary()

-
rtype
-

QFileInfo

-
-
-

isCustom()

-
rtype
-

bool

-
-
-

isValid()

-
rtype
-

bool

-
-
-

steamAppID()

-
rtype
-

str

-
-
-

title()

-
rtype
-

str

-
-
-

withArgument(argument)

-
rtype
-

ExecutableInfo

-
-
-

withSteamAppId(app_id)

-
rtype
-

ExecutableInfo

-
-
-

withWorkingDirectory(directory)

-
rtype
-

ExecutableInfo

-
-
-

workingDirectory()

-
rtype
-

QDir

-
-
-

-

Methods Documentation

-
-
-arguments()Ā¶
-
-
Return type
-

List[str]

-
-
-
- -
-
-asCustom()Ā¶
-
-
Return type
-

ExecutableInfo

-
-
-
- -
-
-binary()Ā¶
-
-
Return type
-

QFileInfo

-
-
-
- -
-
-isCustom()Ā¶
-
-
Return type
-

bool

-
-
-
- -
-
-isValid()Ā¶
-
-
Return type
-

bool

-
-
-
- -
-
-steamAppID()Ā¶
-
-
Return type
-

str

-
-
-
- -
-
-title()Ā¶
-
-
Return type
-

str

-
-
-
- -
-
-withArgument(argument)Ā¶
-
-
Return type
-

ExecutableInfo

-
-
-
- -
-
-withSteamAppId(app_id)Ā¶
-
-
Return type
-

ExecutableInfo

-
-
-
- -
-
-withWorkingDirectory(directory)Ā¶
-
-
Return type
-

ExecutableInfo

-
-
-
- -
-
-workingDirectory()Ā¶
-
-
Return type
-

QDir

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.FileInfo.html b/gh-pages/api/mobase.FileInfo.html deleted file mode 100644 index 24318dc..0000000 --- a/gh-pages/api/mobase.FileInfo.html +++ /dev/null @@ -1,379 +0,0 @@ - - - - - - - - - - FileInfo — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

FileInfoĀ¶

-
-
-class mobase.FileInfoĀ¶
-

Bases: object

-

Information about a virtualised file

-

Attributes Summary

- ---- - - - - - - - - - - - -

archive

str

filePath

str

origins

List[str]

-

Attributes Documentation

-
-
-archiveĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
-
-filePathĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
-
-originsĀ¶
-

List[str]

-
-
Type
-

rtype

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.FileTreeEntry.html b/gh-pages/api/mobase.FileTreeEntry.html deleted file mode 100644 index f5361d5..0000000 --- a/gh-pages/api/mobase.FileTreeEntry.html +++ /dev/null @@ -1,600 +0,0 @@ - - - - - - - - - - FileTreeEntry — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

FileTreeEntryĀ¶

-
-
-class mobase.FileTreeEntryĀ¶
-

Bases: object

-

Represent an entry in a file tree, either a file or a directory. This class -inherited by IFileTree so that operations on entry are the same for a file or -a directory.

-

This class provides convenience methods to query information on the file, like its -name or the its last modification time. It also provides a convenience astree() method -that can be used to retrieve the tree corresponding to its entry in case the entry -represent a directory.

-

Attributes Summary

- ---- - - - - - - - - - - - -

DIRECTORY

FILE

FILE_OR_DIRECTORY

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

detach()

Detach this entry from its parent tree.

fileType()

-
returns
-

The filetype of this entry.

-
-
-

hasSuffix(**kwds)

Helper for @overload to raise when called.

isDir()

-
returns
-

True if this entry is a directory, False otherwise.

-
-
-

isFile()

-
returns
-

True if this entry is a file, False otherwise.

-
-
-

moveTo(tree)

Move this entry to the given tree.

name()

-
returns
-

The name of this entry.

-
-
-

parent()

-
returns
-

The parent tree containing this entry, or a None if this entry is the root

-
-
-

path([sep])

Retrieve the path from this entry up to the root of the tree.

pathFrom(tree[,Ā sep])

Retrieve the path from the given tree to this entry.

suffix()

Retrieve the ā€œlastā€ extension of this entry.

-

Attributes Documentation

-
-
-DIRECTORY: FileTreeEntry.FileTypes = EllipsisĀ¶
-
- -
-
-FILE: FileTreeEntry.FileTypes = EllipsisĀ¶
-
- -
-
-FILE_OR_DIRECTORY: FileTreeEntry.FileTypes = EllipsisĀ¶
-
- -

Methods Documentation

-
-
-detach()Ā¶
-

Detach this entry from its parent tree.

-
-
Returns
-

True if the entry was removed correctly, False otherwize.

-
-
Return type
-

bool

-
-
-
- -
-
-fileType()Ā¶
-
-
Returns
-

The filetype of this entry.

-
-
Return type
-

FileTypes

-
-
-
- -
-
-hasSuffix(**kwds)Ā¶
-

Helper for @overload to raise when called.

-
- -
-
-isDir()Ā¶
-
-
Returns
-

True if this entry is a directory, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-isFile()Ā¶
-
-
Returns
-

True if this entry is a file, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-moveTo(tree)Ā¶
-

Move this entry to the given tree.

-
-
Parameters
-

tree ā€“ The tree to move this entry to.

-
-
Returns
-

True if the entry was moved correctly, False otherwize.

-
-
Return type
-

bool

-
-
-
- -
-
-name()Ā¶
-
-
Returns
-

The name of this entry.

-
-
Return type
-

str

-
-
-
- -
-
-parent()Ā¶
-
-
Returns
-

The parent tree containing this entry, or a None if this entry is the root

-
-
-

or the parent tree is unreachable.

-
-
Return type
-

Optional[IFileTree]

-
-
-
- -
-
-path(sep='\\')Ā¶
-

Retrieve the path from this entry up to the root of the tree.

-

This method propagate up the tree so is not constant complexity as -the full path is never stored.

-
-
Parameters
-

sep ā€“ The type of separator to use to create the path.

-
-
Returns
-

The path from this entry to the root, including the name of this entry.

-
-
Return type
-

str

-
-
-
- -
-
-pathFrom(tree, sep='\\')Ā¶
-

Retrieve the path from the given tree to this entry.

-
-
Parameters
-
    -

  • tree ā€“ The tree to reach, must be a parent of this entry.

    • -

  • sep ā€“ The type of separator to use to create the path.

    • -
-
-
Returns
-

The path from the given tree to this entry, including the name of this entry, or

-
-
-

an empty string if the given tree is not a parent of this entry.

-
-
Return type
-

str

-
-
-
- -
-
-suffix()Ā¶
-

Retrieve the ā€œlastā€ extension of this entry.

-

The ā€œlastā€ extension is everything after the last dot in the file name.

-
-
Returns
-

The last extension of this entry, or an empty string if the file has no extension

-
-
-

or is directory.

-
-
Return type
-

str

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.GamePlugins.html b/gh-pages/api/mobase.GamePlugins.html deleted file mode 100644 index 58906d1..0000000 --- a/gh-pages/api/mobase.GamePlugins.html +++ /dev/null @@ -1,391 +0,0 @@ - - - - - - - - - - GamePlugins — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

GamePluginsĀ¶

-
-
-class mobase.GamePluginsĀ¶
-

Bases: abc.ABC

-

Methods Summary

- ---- - - - - - - - - - - - - - - -

getLoadOrder()

-
rtype
-

List[str]

-
-
-

lightPluginsAreSupported()

-
returns
-

True if light plugins are supported, False otherwise.

-
-
-

readPluginLists(plugin_list)

writePluginLists(plugin_list)

-

Methods Documentation

-
-
-abstract getLoadOrder()Ā¶
-
-
Return type
-

List[str]

-
-
-
- -
-
-abstract lightPluginsAreSupported()Ā¶
-
-
Returns
-

True if light plugins are supported, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-abstract readPluginLists(plugin_list)Ā¶
-
- -
-
-abstract writePluginLists(plugin_list)Ā¶
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.GuessQuality.html b/gh-pages/api/mobase.GuessQuality.html deleted file mode 100644 index 1e44261..0000000 --- a/gh-pages/api/mobase.GuessQuality.html +++ /dev/null @@ -1,386 +0,0 @@ - - - - - - - - - - GuessQuality — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

GuessQualityĀ¶

-
-
-class mobase.GuessQualityĀ¶
-

Bases: enum.Enum

-

Describes how good the code considers a guess (i.e. for a mod name) this is used to -determine if a name from another source should overwrite or not.

-

Attributes Summary

- ---- - - - - - - - - - - - - - - - - - - - - -

FALLBACK

GOOD

INVALID

META

PRESET

USER

-

Attributes Documentation

-
-
-FALLBACK = EllipsisĀ¶
-
- -
-
-GOOD = EllipsisĀ¶
-
- -
-
-INVALID = EllipsisĀ¶
-
- -
-
-META = EllipsisĀ¶
-
- -
-
-PRESET = EllipsisĀ¶
-
- -
-
-USER = EllipsisĀ¶
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.GuessedString.html b/gh-pages/api/mobase.GuessedString.html deleted file mode 100644 index 419e540..0000000 --- a/gh-pages/api/mobase.GuessedString.html +++ /dev/null @@ -1,395 +0,0 @@ - - - - - - - - - - GuessedString — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

GuessedStringĀ¶

-
-
-class mobase.GuessedString(**kwds)Ā¶
-

Bases: object

-

Represents a string that may be set from different places. Each time the value is -changed a ā€œqualityā€ is specified to say how probable it is the value is the best choice. -Only the best choice should be used in the end but alternatives can be queried. This -class also allows a filter to be set. If a ā€œguessā€ doesnā€™t pass the filter, it is ignored.

-

Methods Summary

- ---- - - - - - - - - - - - - - - -

reset(**kwds)

Helper for @overload to raise when called.

setFilter(filter)

Set the filter for this GuessedString.

update(**kwds)

Helper for @overload to raise when called.

variants()

-
returns
-

The list of variants for this GuessedString.

-
-
-

-

Methods Documentation

-
-
-reset(**kwds)Ā¶
-

Helper for @overload to raise when called.

-
- -
-
-setFilter(filter)Ā¶
-

Set the filter for this GuessedString.

-

The filter is applied on every update() and can reject the new value -altogether or modify it (by returning a new value).

-
-
Parameters
-

filter ā€“ The new filter.

-
-
-
- -
-
-update(**kwds)Ā¶
-

Helper for @overload to raise when called.

-
- -
-
-variants()Ā¶
-
-
Returns
-

The list of variants for this GuessedString.

-
-
Return type
-

List[str]

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IDownloadManager.html b/gh-pages/api/mobase.IDownloadManager.html deleted file mode 100644 index 30b8f62..0000000 --- a/gh-pages/api/mobase.IDownloadManager.html +++ /dev/null @@ -1,447 +0,0 @@ - - - - - - - - - - IDownloadManager — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IDownloadManagerĀ¶

-
-
-class mobase.IDownloadManagerĀ¶
-

Bases: PyQt5.QtCore.QObject

-

Attributes Summary

- ---- - - - - - - - - - - - - - - -

downloadComplete

downloadFailed

downloadPaused

downloadRemoved

-

Methods Summary

- ---- - - - - - - - - - - - -

downloadPath(id)

Retrieve the (absolute) path of the specified download.

startDownloadNexusFile(mod_id,Ā file_id)

Download a file from www.nexusmods.com/<game>.

startDownloadURLs(urls)

Download a file by url.

-

Attributes Documentation

-
-
-downloadComplete: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -
-
-downloadFailed: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -
-
-downloadPaused: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -
-
-downloadRemoved: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -

Methods Documentation

-
-
-downloadPath(id)Ā¶
-

Retrieve the (absolute) path of the specified download.

-
-
Parameters
-

id ā€“ ID of the download.

-
-
Returns
-

The absolute path to the file corresponding to the given download. This file

-
-
-

may not exist yet if the download is incomplete.

-
-
Return type
-

str

-
-
-
- -
-
-startDownloadNexusFile(mod_id, file_id)Ā¶
-

Download a file from www.nexusmods.com/<game>. <game> is always the game -currently being managed.

-
-
Parameters
-
    -

  • mod_id ā€“ ID of the mod to download the file from.

    • -

  • file_id ā€“ ID of the file to download.

    • -
-
-
Returns
-

An ID identifying the download.

-
-
Return type
-

int

-
-
-
- -
-
-startDownloadURLs(urls)Ā¶
-

Download a file by url.

-

The list can contain alternative URLs to allow the download manager to switch -in case of download problems

-
-
Parameters
-

urls ā€“ List of urls to download from.

-
-
Returns
-

An ID identifying the download.

-
-
Return type
-

int

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IFileTree.html b/gh-pages/api/mobase.IFileTree.html deleted file mode 100644 index 511fe7b..0000000 --- a/gh-pages/api/mobase.IFileTree.html +++ /dev/null @@ -1,816 +0,0 @@ - - - - - - - - - - IFileTree — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IFileTreeĀ¶

-
-
-class mobase.IFileTreeĀ¶
-

Bases: mobase.FileTreeEntry

-

Interface to classes that provides way to visualize and alter file trees. The tree -may not correspond to an actual file tree on the disk (e.g., inside an archive, -from a QTree Widget, ā€¦).

-

Read-only operations on the tree are thread-safe, even when the tree has not been populated -yet.

-

In order to prevent wrong usage of the tree, implementing classes may throw -UnsupportedOperationException if an operation is not supported. By default, all operations -are supported, but some may not make sense in many situations.

-

The goal of this is not reflect the change made to a IFileTree to the disk, but child -classes may override relevant methods to do so.

-

The tree is built upon FileTreeEntry. A given tree holds shared pointers to its entries -while each entry holds a weak pointer to its parent, this means that the descending link -are strong (shared pointers) but the uplink are weaks.

-

Accessing the parent is always done by locking the weak pointer so that returned pointer -or either null or valid. This structure implies that as long as the initial root lives, -entry should not be destroyed, unless the entry are detached from the root and no shared -pointers are kept.

-

However, it is not guarantee that one can go up the tree from a single node entry. If the -root node is destroyed, it will not be possible to go up the tree, even if we still have -a valid shared pointer.

-

Attributes Summary

- ---- - - - - - - - - - - - - - - - - - - - - -

CONTINUE

FAIL_IF_EXISTS

MERGE

REPLACE

SKIP

STOP

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

addDirectory(path)

Create a new directory tree under this tree.

addFile(path[,Ā replace_if_exists])

Create a new file directly under this tree.

clear()

Delete (detach) all the entries from this tree.

copy(entry[,Ā path,Ā policy])

Move the given entry to the given path under this tree.

createOrphanTree([name])

Create a new orphan empty tree.

exists(path[,Ā type])

Check if the given entry exists.

find(path[,Ā type])

Retrieve the given entry.

insert(entry[,Ā policy])

Insert the given entry in this tree, removing it from its previouis parent.

merge(other[,Ā overwrites])

Merge the given tree with this tree, i.e., insert all entries of the given tree into this tree.

move(entry,Ā path[,Ā policy])

Move the given entry to the given path under this tree.

pathTo(entry[,Ā sep])

Retrieve the path from this tree to the given entry.

remove(**kwds)

Helper for @overload to raise when called.

removeAll(names)

Delete the entries with the given names from the tree.

removeIf(filter)

Delete entries matching the given predicate from the tree.

walk(callback[,Ā sep])

Walk this tree, calling the given function for each entry in it.

-

Attributes Documentation

-
-
-CONTINUE: IFileTree.WalkReturn = EllipsisĀ¶
-
- -
-
-FAIL_IF_EXISTS: IFileTree.InsertPolicy = EllipsisĀ¶
-
- -
-
-MERGE: IFileTree.InsertPolicy = EllipsisĀ¶
-
- -
-
-REPLACE: IFileTree.InsertPolicy = EllipsisĀ¶
-
- -
-
-SKIP: IFileTree.WalkReturn = EllipsisĀ¶
-
- -
-
-STOP: IFileTree.WalkReturn = EllipsisĀ¶
-
- -

Methods Documentation

-
-
-addDirectory(path)Ā¶
-

Create a new directory tree under this tree.

-

This method will create missing folders in the given path and will -not fail if the directory already exists but will fail if the given -path contains ā€œ.ā€ or ā€œ..ā€. -This method invalidates iterators to this tree and all the subtrees -present in the given path.

-
-
Parameters
-

path ā€“ Path to the directory to create.

-
-
Returns
-

An IFileTree corresponding to the created directory.

-
-
Raises
-

RuntimeError ā€“ If the directory could not be created.

-
-
Return type
-

IFileTree

-
-
-
- -
-
-addFile(path, replace_if_exists=False)Ā¶
-

Create a new file directly under this tree.

-

This method will fail if the file already exists and replace_if_exists is False. -This method invalidates iterators to this tree and all the subtrees present in the -given path.

-
-
Parameters
-
    -

  • path ā€“ Path to the file to create.

    • -

  • replace_if_exists ā€“ If True and an entry already exists at the given location, it will be replaced by a new entry. This will replace both files and directories.

    • -
-
-
Returns
-

A FileTreeEntry corresponding to the created file.

-
-
Raises
-

RuntimeError ā€“ If the file could not be created.

-
-
Return type
-

FileTreeEntry

-
-
-
- -
-
-clear()Ā¶
-

Delete (detach) all the entries from this tree.

-

This method will go through the entries in this tree and stop at the first -entry that cannot be deleted, this means that the tree can be partially cleared.

-
-
Returns
-

True if all entries have been detached, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-copy(entry, path='', policy=<InsertPolicy.FAIL_IF_EXISTS: Ellipsis>)Ā¶
-

Move the given entry to the given path under this tree.

-

The entry must not be a parent tree of this tree. This method can also be used -to rename entries.

-

If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry -at the same location already exists. If the policy is REPLACE, an existing -entry will be replaced. If MERGE, the entry will be merged with the existing -one (if the entry is a file, and a file exists, the file will be replaced).

-

This method invalidates iterator to this tree, to the parent tree of the given -entry, and to subtrees of this tree if the insert policy is MERGE.

-
-
Parameters
-
    -

  • entry ā€“ Entry to copy.

    • -

  • path ā€“ The path to copy the entry to. If the path ends with / or , the entry will be copied in the corresponding directory instead of replacing it. If the -given path is empty (ā€œā€), the entry is copied directly under this tree.

    • -

  • policy ā€“ Policy to use to resolve conflicts.

    • -
-
-
Returns
-

The new entry (copy of the specified entry).

-
-
Raises
-

RuntimeError ā€“ If the entry could not be copied.

-
-
Return type
-

FileTreeEntry

-
-
-
- -
-
-createOrphanTree(name='')Ā¶
-

Create a new orphan empty tree.

-
-
Parameters
-

name ā€“ Name of the tree.

-
-
Returns
-

A new tree without any parent.

-
-
Return type
-

IFileTree

-
-
-
- -
-
-exists(path, type=<FileTypes.DIRECTORY: Ellipsis>)Ā¶
-

Check if the given entry exists.

-
-
Parameters
-
    -

  • path ā€“ Path to the entry, separated by / or .

    • -

  • type ā€“ The type of the entry to check.

    • -
-
-
Returns
-

True if the entry was found, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-find(path, type=<FileTypes.DIRECTORY: Ellipsis>)Ā¶
-

Retrieve the given entry.

-

If no entry exists at the given path, or if the entry is not of the right -type, None is returned.

-
-
Parameters
-
    -

  • path ā€“ Path to the entry, separated by / or .

    • -

  • type ā€“ The type of the entry to check.

    • -
-
-
Returns
-

The entry at the given location, or None if the entry was not found or

-
-
-

was not of the correct type.

-
-
Return type
-

Union[IFileTree, FileTreeEntry, None]

-
-
-
- -
-
-insert(entry, policy=<InsertPolicy.FAIL_IF_EXISTS: Ellipsis>)Ā¶
-

Insert the given entry in this tree, removing it from its -previouis parent.

-

The entry must not be this tree or a parent entry of this tree.

-
-
    -

  • If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry -with the same name already exists.

    • -

  • If the policy is REPLACE, an existing entry will be replaced by the given entry.

    • -

  • If the policy is MERGE:

    -
      -

    • If there is no entry with the same name, the new entry is inserted.

      • -

    • If there is an entry with the same name:

      -
        -

      • If both entries are files, the old file is replaced by the given entry.

        • -

      • If both entries are directories, a merge is performed as if using merge().

        • -

      • Otherwize the insertion fails (two entries with different types).

        • -
      -
      • -
    -
    • -
-
-

This method invalidates iterator to this tree, to the parent tree of the given -entry, and to subtrees of this tree if the insert policy is MERGE.

-
-
Parameters
-
    -

  • entry ā€“ Entry to insert.

    • -

  • policy ā€“ Policy to use to resolve conflicts.

    • -
-
-
Returns
-

True if the entry was insert, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-merge(other, overwrites=False)Ā¶
-

Merge the given tree with this tree, i.e., insert all entries -of the given tree into this tree.

-

The tree must not be this tree or a parent entry of this tree. Files present in both tree -will be replaced by files in the given tree. After a merge, the source tree will be -empty but still attached to its parent.

-

If overwrites is True, a map from overriden files to new files will be returned.

-

Note that the merge process makes no distinction between files and directories -when merging: if a directory is present in this tree and a file from source -is in conflict with it, the tree will be removed and the file inserted; if a file -is in this tree and a directory from source is in conflict with it, the file will -be replaced with the directory.

-

This method invalidates iterators to this tree, all the subtrees under this tree -present in the given path, and all the subtrees of the given source.

-
-
Parameters
-
    -

  • other ā€“ Tree to merge.

    • -

  • overwrites ā€“ If True, a mapping from overriden files to new files will be returned.

    • -
-
-
Returns
-

If overwrites is True, a mapping from overriden files to new files, otherwise

-
-
-

the number of overwritten entries.

-
-
Raises
-

RuntimeError ā€“ If the merge failed.

-
-
Return type
-

Union[Dict[FileTreeEntry, FileTreeEntry], int]

-
-
-
- -
-
-move(entry, path, policy=<InsertPolicy.FAIL_IF_EXISTS: Ellipsis>)Ā¶
-

Move the given entry to the given path under this tree.

-

The entry must not be a parent tree of this tree. This method can also be used -to rename entries.

-

If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry -at the same location already exists. If the policy is REPLACE, an existing -entry will be replaced. If MERGE, the entry will be merged with the existing -one (if the entry is a file, and a file exists, the file will be replaced).

-

This method invalidates iterator to this tree, to the parent tree of the given -entry, and to subtrees of this tree if the insert policy is MERGE.

-
-
Parameters
-
    -

  • entry ā€“ Entry to move.

    • -

  • path ā€“ The path to move the entry to. If the path ends with / or , the entry will be inserted in the corresponding directory instead of replacing it. If the -given path is empty (ā€œā€), this is equivalent to insert().

    • -

  • policy ā€“ Policy to use to resolve conflicts.

    • -
-
-
Returns
-

True if the entry was moved correctly, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-pathTo(entry, sep='\\')Ā¶
-

Retrieve the path from this tree to the given entry.

-
-
Parameters
-
    -

  • entry ā€“ The entry to reach, must be in this tree.

    • -

  • sep ā€“ The type of separator to use to create the path.

    • -
-
-
Returns
-

The path from this tree to the given entry, including the name of the entry, or

-
-
-

an empty string if the given entry was not found under this tree.

-
-
Return type
-

str

-
-
-
- -
-
-remove(**kwds)Ā¶
-

Helper for @overload to raise when called.

-
- -
-
-removeAll(names)Ā¶
-

Delete the entries with the given names from the tree.

-

This method does not recurse into subtrees, so only entries accessible -directly from this tree will be removed. This method invalidates iterators.

-
-
Parameters
-

names ā€“ Names of the entries to delete.

-
-
Returns
-

The number of deleted entry.

-
-
Return type
-

int

-
-
-
- -
-
-removeIf(filter)Ā¶
-

Delete entries matching the given predicate from the tree.

-

This method does not recurse into subtrees, so only entries accessible -directly from this tree will be removed. This method invalidates iterators.

-
-
Parameters
-

filter ā€“ Predicate that should return true for entries to delete.

-
-
Returns
-

The number of deleted entry.

-
-
Return type
-

int

-
-
-
- -
-
-walk(callback, sep='\\')Ā¶
-

Walk this tree, calling the given function for each entry in it.

-

The given callback will be called with two parameters: the path from this tree to the given entry -(with a trailing separator, not including the entry name), and the actual entry. The method returns -a WalkReturn object to indicates what to do.

-
-
Parameters
-
    -

  • callback ā€“ Method to call for each entry in the tree.

    • -

  • sep ā€“ Type of separator to use to construct the path.

    • -
-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IInstallationManager.html b/gh-pages/api/mobase.IInstallationManager.html deleted file mode 100644 index 42d484e..0000000 --- a/gh-pages/api/mobase.IInstallationManager.html +++ /dev/null @@ -1,478 +0,0 @@ - - - - - - - - - - IInstallationManager — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IInstallationManagerĀ¶

-
-
-class mobase.IInstallationManagerĀ¶
-

Bases: object

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - -

createFile(entry)

Create a new file on the disk corresponding to the given entry.

extractFile(entry[,Ā silent])

Extract the specified file from the currently opened archive to a temporary location.

extractFiles(entries[,Ā silent])

Extract the specified files from the currently opened archive to a temporary location.

getSupportedExtensions()

-
returns
-

The extensions of archives supported by this installation manager.

-
-
-

installArchive(mod_name,Ā archive,Ā mod_id)

Install the given archive.

setURL(url)

Set the url associated with the mod being installed.

-

Methods Documentation

-
-
-createFile(entry)Ā¶
-

Create a new file on the disk corresponding to the given entry.

-

This method can be used by installer that needs to create files that are not in the original -archive. At the end of the installation, if there are entries in the final tree that were used -to create files, the corresponding files will be moved to the mod folder.

-

Temporary files corresponding to created files are automatically cleaned up at the end of -the installation.

-
-
Parameters
-

entry ā€“ The entry for which a temporary file should be created.

-
-
Returns
-

The path to the created file, or an empty string if the file could not be created.

-
-
Return type
-

str

-
-
-
- -
-
-extractFile(entry, silent=False)Ā¶
-

Extract the specified file from the currently opened archive to a temporary -location.

-

This method cannot be used to extract directory.

-

The call will fail with an exception if no archive is open (plugins deriving from -IPluginInstallerSimple can rely on that, custom installers should not). The temporary -file is automatically cleaned up after the installation. This call can be very slow -if the archive is large and ā€œsolidā€.

-
-
Parameters
-
    -

  • entry ā€“ Entry corresponding to the file to extract.

    • -

  • silent ā€“ If true, the dialog showing extraction progress will not be shown.

    • -
-
-
Returns
-

The absolute path to the temporary file, or an empty string if the file was not extracted.

-
-
Return type
-

str

-
-
-
- -
-
-extractFiles(entries, silent=False)Ā¶
-

Extract the specified files from the currently opened archive to a temporary -location.

-

This method cannot be used to extract directories.

-

The call will fail with an exception if no archive is open (plugins deriving from -IPluginInstallerSimple can rely on that, custom installers should not). The temporary -files are automatically cleaned up after the installation. This call can be very slow -if the archive is large and ā€œsolidā€.

-
-
Parameters
-
    -

  • entries ā€“ Entries corresponding to the files to extract.

    • -

  • silent ā€“ If true, the dialog showing extraction progress will not be shown.

    • -
-
-
Returns
-

A list containing absolute paths to the temporary files.

-
-
Return type
-

List[str]

-
-
-
- -
-
-getSupportedExtensions()Ā¶
-
-
Returns
-

The extensions of archives supported by this installation manager.

-
-
Return type
-

List[str]

-
-
-
- -
-
-installArchive(mod_name, archive, mod_id)Ā¶
-

Install the given archive.

-
-
Parameters
-
    -

  • mod_name ā€“ Suggested name of the mod.

    • -

  • archive ā€“ Path to the archive to install.

    • -

  • mod_id ā€“ ID of the mod, if available.

    • -
-
-
Returns
-

The result of the installation.

-
-
Return type
-

InstallResult

-
-
-
- -
-
-setURL(url)Ā¶
-

Set the url associated with the mod being installed.

-
-
Parameters
-

url ā€“ Url to set.

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IModInterface.html b/gh-pages/api/mobase.IModInterface.html deleted file mode 100644 index ead7c16..0000000 --- a/gh-pages/api/mobase.IModInterface.html +++ /dev/null @@ -1,563 +0,0 @@ - - - - - - - - - - IModInterface — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IModInterfaceĀ¶

-
-
-class mobase.IModInterfaceĀ¶
-

Bases: object

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

absolutePath()

-
returns
-

Absolute path to the mod to be used in file system operations.

-
-
-

addCategory(name)

Assign a category to the mod.

addNexusCategory(category_id)

Set the category id from a nexus category id.

categories()

-
returns
-

The list of categories assigned to this mod.

-
-
-

name()

-
returns
-

The name of this mod.

-
-
-

remove()

Delete the mod from the disc.

removeCategory(name)

Unassign a category from this mod.

setGameName(name)

Set the source game of this mod.

setIsEndorsed(endorsed)

Set endorsement state of the mod.

setName(name)

Set the name of this mod.

setNewestVersion(version)

Set the latest known version of this mod.

setNexusID(nexus_id)

Set the Nexus ID of this mod.

setVersion(version)

Set the version of this mod.

-

Methods Documentation

-
-
-absolutePath()Ā¶
-
-
Returns
-

Absolute path to the mod to be used in file system operations.

-
-
Return type
-

str

-
-
-
- -
-
-addCategory(name)Ā¶
-

Assign a category to the mod. If the named category does not exist it is created.

-
-
Parameters
-

name ā€“ Name of the new category to assign.

-
-
-
- -
-
-addNexusCategory(category_id)Ā¶
-

Set the category id from a nexus category id. Conversion to MO ID happens internally.

-

If a mapping is not possible, the category is set to the default value.

-
-
Parameters
-

category_id ā€“ The Nexus category ID.

-
-
-
- -
-
-categories()Ā¶
-
-
Returns
-

The list of categories assigned to this mod.

-
-
Return type
-

List[str]

-
-
-
- -
-
-name()Ā¶
-
-
Returns
-

The name of this mod.

-
-
Return type
-

str

-
-
-
- -
-
-remove()Ā¶
-

Delete the mod from the disc.

-

This does not update the global ModInfo structure or indices.

-
-
Returns
-

True if the mod was deleted, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-removeCategory(name)Ā¶
-

Unassign a category from this mod.

-
-
Parameters
-

name ā€“ Name of the category to remove.

-
-
Returns
-

True if the category was removed, False otherwise (e.g. if no such category

-
-
-

was assigned).

-
-
Return type
-

bool

-
-
-
- -
-
-setGameName(name)Ā¶
-

Set the source game of this mod.

-
-
Parameters
-

name ā€“ The new source game short name of this mod.

-
-
-
- -
-
-setIsEndorsed(endorsed)Ā¶
-

Set endorsement state of the mod.

-
-
Parameters
-

endorsed ā€“ New endorsement state of this mod.

-
-
-
- -
-
-setName(name)Ā¶
-

Set the name of this mod.

-

This will also update the name of the directory that contains this mod

-
-
Parameters
-

name ā€“ New name for this mod.

-
-
Returns
-

True if the name was changed, False if an error occured (e.g. if the name is not a valid

-
-
-

directory name).

-
-
Return type
-

bool

-
-
-
- -
-
-setNewestVersion(version)Ā¶
-

Set the latest known version of this mod.

-
-
Parameters
-

version ā€“ The latest known version of this mod.

-
-
-
- -
-
-setNexusID(nexus_id)Ā¶
-

Set the Nexus ID of this mod.

-
-
Parameters
-

nexus_id ā€“ Thew new Nexus ID of this mod.

-
-
-
- -
-
-setVersion(version)Ā¶
-

Set the version of this mod.

-
-
Parameters
-

version ā€“ The new version of this mod.

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IModList.html b/gh-pages/api/mobase.IModList.html deleted file mode 100644 index b8e10b8..0000000 --- a/gh-pages/api/mobase.IModList.html +++ /dev/null @@ -1,515 +0,0 @@ - - - - - - - - - - IModList — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IModListĀ¶

-
-
-class mobase.IModListĀ¶
-

Bases: object

-

Interface to the mod-list.

-

All api functions in this interface work need the internal name of a mod to find a -mod. For regular mods (mods the user installed) the display name (as shown to the user) -and internal name are identical. For other mods (non-MO mods) there is currently no way -to translate from display name to internal name because the display name might not me un-ambiguous.

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

allMods()

-
returns
-

A list containing the internal names of all installed mods.

-
-
-

displayName(name)

Retrieve the display name of a mod from its internal name.

onModMoved(callback)

Install a handler to be called when a mod is moved.

onModStateChanged(callback)

Install a handler to be called when a mod state changes (enabled/disabled, endorsed, ā€¦).

priority(name)

Retrieve the priority of a mod.

setActive(name,Ā active)

Enable or disable a mod.

setPriority(name,Ā priority)

Change the priority of a mod.

state(name)

Retrieve the state of a mod.

-

Methods Documentation

-
-
-allMods()Ā¶
-
-
Returns
-

A list containing the internal names of all installed mods.

-
-
Return type
-

List[str]

-
-
-
- -
-
-displayName(name)Ā¶
-

Retrieve the display name of a mod from its internal name.

-

If you received an internal name from the API (e.g. IPluginList.origin) then you should use -that name to identify the mod in all other api calls but use this function to retrieve the name -to show to the user.

-
-
Parameters
-

name ā€“ Internal name of the mod.

-
-
Returns
-

The display name of the given mod.

-
-
Return type
-

str

-
-
-
- -
-
-onModMoved(callback)Ā¶
-

Install a handler to be called when a mod is moved.

-
-
Parameters
-

callback ā€“ The function to call when a mod is moved. The first argument is the internal name of the mod, the second argument the old priority and the third argument the new priority.

-
-
Returns
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
Return type
-

bool

-
-
-
- -
-
-onModStateChanged(callback)Ā¶
-

Install a handler to be called when a mod state changes (enabled/disabled, endorsed, ā€¦).

-
-
Parameters
-

callback ā€“ The function to call when the state of a mod changes. The first argument is the internal mod name, and the second one the new state of the mod.

-
-
Returns
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
Return type
-

bool

-
-
-
- -
-
-priority(name)Ā¶
-

Retrieve the priority of a mod.

-
-
Parameters
-

name ā€“ Internal name of the mod.

-
-
Returns
-

The priority of the given mod.

-
-
Return type
-

int

-
-
-
- -
-
-setActive(name, active)Ā¶
-

Enable or disable a mod.

-

Calling this will cause MO to re-evaluate its virtual file system so this is -a fairly expensive call.

-
-
Parameters
-
    -

  • name ā€“ Internal name of the mod to enable or disable.

    • -

  • active ā€“ True to enable the mod, False to disable it.

    • -
-
-
Returns
-

True on success, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-setPriority(name, priority)Ā¶
-

Change the priority of a mod.

-

priority is the new priority after the move. Keep in mind that the mod disappears from its -old location and all mods with higher priority than the moved mod decrease in priority by one.

-
-
Parameters
-
    -

  • name ā€“ Internal name of the mod.

    • -

  • priority ā€“ The new priority of the mod.

    • -
-
-
Returns
-

True if the priority was changed, False otherwise (if the name or priority were invalid).

-
-
Return type
-

bool

-
-
-
- -
-
-state(name)Ā¶
-

Retrieve the state of a mod.

-
-
Parameters
-

name ā€“ Internal name of the mod.

-
-
Returns
-

The state of the given mod.

-
-
Return type
-

int

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IModRepositoryBridge.html b/gh-pages/api/mobase.IModRepositoryBridge.html deleted file mode 100644 index 2d85ba2..0000000 --- a/gh-pages/api/mobase.IModRepositoryBridge.html +++ /dev/null @@ -1,520 +0,0 @@ - - - - - - - - - - IModRepositoryBridge — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IModRepositoryBridgeĀ¶

-
-
-class mobase.IModRepositoryBridgeĀ¶
-

Bases: PyQt5.QtCore.QObject

-

Attributes Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

descriptionAvailable

downloadURLsAvailable

endorsementToggled

endorsementsAvailable

fileInfoAvailable

filesAvailable

requestFailed

trackedModsAvailable

trackingToggled

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - -

requestDescription(game_name,Ā mod_id,Ā user_data)

Request description of a mod.

requestDownloadURL(game_name,Ā mod_id,Ā ā€¦)

Request download URL for mod file.0

requestFileInfo(game_name,Ā mod_id,Ā file_id,Ā ā€¦)

-
param game_name
-

Name of the game containing the mod.

-
-
-

requestFiles(game_name,Ā mod_id,Ā user_data)

Request the list of files belonging to a mod.

requestToggleEndorsement(game_name,Ā mod_id,Ā ā€¦)

-
param game_name
-

Name of the game containing the mod.

-
-
-

-

Attributes Documentation

-
-
-descriptionAvailable: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -
-
-downloadURLsAvailable: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -
-
-endorsementToggled: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -
-
-endorsementsAvailable: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -
-
-fileInfoAvailable: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -
-
-filesAvailable: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -
-
-requestFailed: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -
-
-trackedModsAvailable: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -
-
-trackingToggled: PyQt5.QtCore.pyqtSignal = EllipsisĀ¶
-
- -

Methods Documentation

-
-
-requestDescription(game_name, mod_id, user_data)Ā¶
-

Request description of a mod.

-
-
Parameters
-
    -

  • game_name ā€“ Name of the game containing the mod.

    • -

  • mod_id ā€“ Nexus ID of the mod.

    • -

  • user_data ā€“ User data to be returned with the result.

    • -
-
-
-
- -
-
-requestDownloadURL(game_name, mod_id, file_id, user_data)Ā¶
-

Request download URL for mod file.0

-
-
Parameters
-
    -

  • game_name ā€“ Name of the game containing the mod.

    • -

  • mod_id ā€“ Nexus ID of the mod.

    • -

  • file_id ā€“ ID of the file for which a URL should be returned.

    • -

  • user_data ā€“ User data to be returned with the result.

    • -
-
-
-
- -
-
-requestFileInfo(game_name, mod_id, file_id, user_data)Ā¶
-
-
Parameters
-
    -

  • game_name ā€“ Name of the game containing the mod.

    • -

  • mod_id ā€“ Nexus ID of the mod.

    • -

  • file_id ā€“ ID of the file for which information is requested.

    • -

  • user_data ā€“ User data to be returned with the result.

    • -
-
-
-
- -
-
-requestFiles(game_name, mod_id, user_data)Ā¶
-

Request the list of files belonging to a mod.

-
-
Parameters
-
    -

  • game_name ā€“ Name of the game containing the mod.

    • -

  • mod_id ā€“ Nexus ID of the mod.

    • -

  • user_data ā€“ User data to be returned with the result.

    • -
-
-
-
- -
-
-requestToggleEndorsement(game_name, mod_id, mod_version, endorse, user_data)Ā¶
-
-
Parameters
-
    -

  • game_name ā€“ Name of the game containing the mod.

    • -

  • mod_id ā€“ Nexus ID of the mod.

    • -

  • mod_version ā€“ Version of the mod.

    • -

  • endorse ā€“

    • -

  • user_data ā€“ User data to be returned with the result.

    • -
-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IOrganizer.html b/gh-pages/api/mobase.IOrganizer.html deleted file mode 100644 index eb9fc79..0000000 --- a/gh-pages/api/mobase.IOrganizer.html +++ /dev/null @@ -1,1146 +0,0 @@ - - - - - - - - - - IOrganizer — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IOrganizerĀ¶

-
-
-class mobase.IOrganizerĀ¶
-

Bases: object

-

Interface to class that provides information about the running session -of Mod Organizer to be used by plugins.

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

appVersion()

-
returns
-

The running version of Mod Organizer.

-
-
-

basePath()

-
returns
-

The absolute path to the base directory of Mod Organizer.

-
-
-

createMod(name)

Create a new mod with the specified name.

createNexusBridge()

Create a new Nexus interface.

downloadManager()

-
returns
-

The interface to the download manager.

-
-
-

downloadsPath()

-
returns
-

The absolute path to the download directory.

-
-
-

findFileInfos(path,Ā filter)

Find files in the virtual directory matching the specified filter.

findFiles(**kwds)

Helper for @overload to raise when called.

getFileOrigins(filename)

Retrieve the file origins for the speicified file.

getGame(name)

Retrieve the game plugin matching the given name.

getMod(name)

Retrieve an interface to a mod using its name.

installMod(filename[,Ā name_suggestion])

Install a mod archive at the specified location.

listDirectories(directory)

Retrieve the list of (virtual) subdirectories in the given path.

managedGame()

-
returns
-

The plugin corresponding to the current game.

-
-
-

modDataChanged(mod)

Notify the organizer that the given mod has changed.

modList()

-
returns
-

The interface to the mod list.

-
-
-

modsPath()

-
returns
-

The (absolute) path to the mods directory.

-
-
-

modsSortedByProfilePriority()

-
returns
-

The list of mod (names), sorted according to the current profile priorities.

-
-
-

onAboutToRun(callback)

Install a new handler to be called when an application is about to run.

onFinishedRun(callback)

Install a new handler to be called when an application has finished running.

onModInstalled(callback)

Install a new handler to be called when a new mod is installed.

onPluginSettingChanged(callback)

Install a new handler to be called when a plugin setting is changed.

onProfileChanged(callback)

Install a new handler to be called when the current profile is changed.

onUserInterfaceInitialized(callback)

Install a new handler to be called when the UI has been fully initialized.

overwritePath()

-
returns
-

The (absolute) path to the overwrite directory.

-
-
-

persistent(plugin_name,Ā key[,Ā default])

Retrieve the specified persistent value for a plugin.

pluginDataPath()

Retrieve the path to a directory where plugin data should be stored.

pluginList()

-
returns
-

The plugin list interface.

-
-
-

pluginSetting(plugin_name,Ā key)

Retrieve settings of plugins.

profile()

-
returns
-

The interface to the current profile.

-
-
-

profileName()

-
returns
-

The name of the current profile, or an empty string if no profile has been loaded (yet).

-
-
-

profilePath()

-
returns
-

The absolute path to the active profile or an empty string if no profile has been loaded (yet).

-
-
-

refreshModList([save_changes])

Refresh the mod list.

removeMod(mod)

Remove a mod (from disc and from the UI).

resolvePath(filename)

Resolves a path relative to the virtual data directory to its absolute real path.

setPersistent(plugin_name,Ā key,Ā value[,Ā sync])

Set the specified persistent value for a plugin.

setPluginSetting(plugin_name,Ā key,Ā value)

Set the specified setting for a plugin.

startApplication(executable[,Ā args,Ā cwd,Ā ā€¦])

Starts an application with virtual filesystem active.

waitForApplication(handle)

Wait for the application corresponding to the given handle to finish.

-

Methods Documentation

-
-
-appVersion()Ā¶
-
-
Returns
-

The running version of Mod Organizer.

-
-
Return type
-

VersionInfo

-
-
-
- -
-
-basePath()Ā¶
-
-
Returns
-

The absolute path to the base directory of Mod Organizer.

-
-
Return type
-

str

-
-
-
- -
-
-createMod(name)Ā¶
-

Create a new mod with the specified name.

-

If a mod with the same name already exists, the user will be queried. If the user chooses -to merge or replace, the call will succeed, otheriwse the call will fail.

-
-
Parameters
-

name ā€“ Name of the mod to create.

-
-
Returns
-

An interface to the newly created mod that can be used to modify it, or None if the mod

-
-
-

could not be created.

-
-
Return type
-

IModInterface

-
-
-
- -
-
-createNexusBridge()Ā¶
-

Create a new Nexus interface.

-
-
Returns
-

The newly created Nexus interface.

-
-
Return type
-

IModRepositoryBridge

-
-
-
- -
-
-downloadManager()Ā¶
-
-
Returns
-

The interface to the download manager.

-
-
Return type
-

IDownloadManager

-
-
-
- -
-
-downloadsPath()Ā¶
-
-
Returns
-

The absolute path to the download directory.

-
-
Return type
-

str

-
-
-
- -
-
-findFileInfos(path, filter)Ā¶
-

Find files in the virtual directory matching the specified filter.

-
-
Parameters
-
    -

  • path ā€“ The path to search in (relative to the ā€˜dataā€™ folder).

    • -

  • filter ā€“ The function to use to filter files. Should return True for the files to keep.

    • -
-
-
Returns
-

The list of QFileInfo corresponding to the matching files.

-
-
Return type
-

List[FileInfo]

-
-
-
- -
-
-findFiles(**kwds)Ā¶
-

Helper for @overload to raise when called.

-
- -
-
-getFileOrigins(filename)Ā¶
-

Retrieve the file origins for the speicified file.

-

The origins are listed with their internal name. The internal name of a mod can differ -from the display name for disambiguation.

-
-
Parameters
-

filename ā€“ Path to the file to retrieve origins for (relative to the ā€˜dataā€™ folder).

-
-
Returns
-

The list of origins that contain the specified file, sorted by their priority.

-
-
Return type
-

List[str]

-
-
-
- -
-
-getGame(name)Ā¶
-

Retrieve the game plugin matching the given name.

-
-
Parameters
-

name ā€“ Name of the game (short name).

-
-
Returns
-

The plugin for the given game, or None if none was found.

-
-
Return type
-

IPluginGame

-
-
-
- -
-
-getMod(name)Ā¶
-

Retrieve an interface to a mod using its name.

-
-
Parameters
-

name ā€“ Name of the mod to retrieve.

-
-
Returns
-

An interface to the given mod, or None if there is no mod with this name

-
-
Return type
-

IModInterface

-
-
-
- -
-
-installMod(filename, name_suggestion='')Ā¶
-

Install a mod archive at the specified location.

-
-
Parameters
-
    -

  • filename ā€“ Absolute filepath to the archive to install.

    • -

  • name_suggestion ā€“ Suggested name for this mod. This can still be changed by the user.

    • -
-
-
Returns
-

An interface to the new installed mod, or None if no installation took place (canceled or failure).

-
-
Return type
-

IModInterface

-
-
-
- -
-
-listDirectories(directory)Ā¶
-

Retrieve the list of (virtual) subdirectories in the given path.

-
-
Parameters
-

directory ā€“ Path to the directory to list (relative to the ā€˜dataā€™ folder).

-
-
Returns
-

The list of directories in the given directory.

-
-
Return type
-

List[str]

-
-
-
- -
-
-managedGame()Ā¶
-
-
Returns
-

The plugin corresponding to the current game.

-
-
Return type
-

IPluginGame

-
-
-
- -
-
-modDataChanged(mod)Ā¶
-

Notify the organizer that the given mod has changed.

-
-
Parameters
-

mod ā€“ The mod that has changed.

-
-
-
- -
-
-modList()Ā¶
-
-
Returns
-

The interface to the mod list.

-
-
Return type
-

IModList

-
-
-
- -
-
-modsPath()Ā¶
-
-
Returns
-

The (absolute) path to the mods directory.

-
-
Return type
-

str

-
-
-
- -
-
-modsSortedByProfilePriority()Ā¶
-
-
Returns
-

The list of mod (names), sorted according to the current profile priorities.

-
-
Return type
-

List[str]

-
-
-
- -
-
-onAboutToRun(callback)Ā¶
-

Install a new handler to be called when an application is about to run.

-

Multiple handlers can be installed. If any of the handler returns False, the application will -not run.

-
-
Parameters
-

callback ā€“ The function to call when an application is about to run. The parameter is the absolute path to the application to run. The function can return False to prevent the application from running.

-
-
Returns
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
Return type
-

bool

-
-
-
- -
-
-onFinishedRun(callback)Ā¶
-

Install a new handler to be called when an application has finished running.

-
-
Parameters
-

callback ā€“ The function to call when an application has finished running. The first parameter is the absolute path to the application, and the second parameter is the exit code of the application.

-
-
Returns
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
Return type
-

bool

-
-
-
- -
-
-onModInstalled(callback)Ā¶
-

Install a new handler to be called when a new mod is installed.

-
-
Parameters
-

callback ā€“ The function to call when a mod is installed. The parameter of the function is the name of the installed mod.

-
-
Returns
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
Return type
-

bool

-
-
-
- -
-
-onPluginSettingChanged(callback)Ā¶
-

Install a new handler to be called when a plugin setting is changed.

-
-
Parameters
-

callback ā€“ The function to call when a plugin setting is changed. The parameters are: The name of the plugin, the name of the setting, the old value (or None if the setting did not exist before) and the new value -of the setting (or None if the setting has been removed).

-
-
Returns
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
Return type
-

bool

-
-
-
- -
-
-onProfileChanged(callback)Ā¶
-

Install a new handler to be called when the current profile is changed.

-

The function is called when the profile is changed but some operations related to -the profile might not be finished when this is called (e.g., the virtual file system -might not be up-to-date).

-
-
Parameters
-

callback ā€“ The function to call when the current profile is changed. The first parameter is the old profile (can be None, e.g. at startup), and the second parameter is the new profile (cannot be None).

-
-
Returns
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
Return type
-

bool

-
-
-
- -
-
-onUserInterfaceInitialized(callback)Ā¶
-

Install a new handler to be called when the UI has been fully initialized.

-
-
Parameters
-

callback ā€“ The function to call when the user-interface has been fully initialized. The parameter is the main window of the application (QMainWindow).

-
-
Returns
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
Return type
-

bool

-
-
-
- -
-
-overwritePath()Ā¶
-
-
Returns
-

The (absolute) path to the overwrite directory.

-
-
Return type
-

str

-
-
-
- -
-
-persistent(plugin_name, key, default=None)Ā¶
-

Retrieve the specified persistent value for a plugin.

-

A persistent is an arbitrary value that the plugin can set and retrieve that is persistently stored -by the main application. There is no UI for the user to change this value but they can directly access -the storage

-
-
Parameters
-
    -

  • plugin_name ā€“ Name of the plugin for which to retrieve the value. This should always be IPlugin::name() unless you have a really good reason to access data of another mod AND if you can verify that plugin is actually installed.

    • -

  • key ā€“ Identifier of the setting.

    • -

  • default ā€“ Default value to return if the key is not set (yet).

    • -
-
-
Returns
-

The value corresponding to the given persistent setting, or def is the key is not found.

-
-
Return type
-

Union[None, bool, int, str, List[Any], Dict[str, Any]]

-
-
-
- -
-
-pluginDataPath()Ā¶
-

Retrieve the path to a directory where plugin data should be stored.

-

For python plugins, it is recommended to use a dedicated folder (per plugin) if you need to -store data (resources, or multiple python files).

-
-
Returns
-

Path to a directory where plugin data should be stored.

-
-
Return type
-

str

-
-
-
- -
-
-pluginList()Ā¶
-
-
Returns
-

The plugin list interface.

-
-
Return type
-

IPluginList

-
-
-
- -
-
-pluginSetting(plugin_name, key)Ā¶
-

Retrieve settings of plugins.

-
-
Parameters
-
    -

  • plugin_name ā€“ Name of the plugin to retrieve the setting for.

    • -

  • key ā€“ Name of the setting to retrieve the value for.

    • -
-
-
Returns
-

The value of the setting.

-
-
Return type
-

Union[None, bool, int, str, List[Any], Dict[str, Any]]

-
-
-
- -
-
-profile()Ā¶
-
-
Returns
-

The interface to the current profile.

-
-
Return type
-

IProfile

-
-
-
- -
-
-profileName()Ā¶
-
-
Returns
-

The name of the current profile, or an empty string if no profile has been loaded (yet).

-
-
Return type
-

str

-
-
-
- -
-
-profilePath()Ā¶
-
-
Returns
-

The absolute path to the active profile or an empty string if no profile has been loaded (yet).

-
-
Return type
-

str

-
-
-
- -
-
-refreshModList(save_changes=True)Ā¶
-

Refresh the mod list.

-
-
Parameters
-

save_changes ā€“ If True, the relevant profile information is saved first (enabled mods and order of mods).

-
-
-
- -
-
-removeMod(mod)Ā¶
-

Remove a mod (from disc and from the UI).

-
-
Parameters
-

mod ā€“ The mod to remove.

-
-
Returns
-

True if the mod was removed, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-resolvePath(filename)Ā¶
-

Resolves a path relative to the virtual data directory to its absolute real path.

-
-
Parameters
-

filename ā€“ Path to resolve.

-
-
Returns
-

The absolute real path, or an empty string if the path was not found.

-
-
Return type
-

str

-
-
-
- -
-
-setPersistent(plugin_name, key, value, sync=True)Ā¶
-

Set the specified persistent value for a plugin.

-

This does not update the in-memory value for this setting, see setPluginSetting() for this.

-
-
Parameters
-
    -

  • plugin_name ā€“ Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a really good reason to access data of another mod AND if you can verify that plugin is actually installed.

    • -

  • key ā€“ Identifier of the setting.

    • -

  • value ā€“ New value for the setting.

    • -

  • sync ā€“ If True, the storage is immediately written to disc. This costs performance but is safer against data loss.

    • -
-
-
-
- -
-
-setPluginSetting(plugin_name, key, value)Ā¶
-

Set the specified setting for a plugin.

-

This automatically notify handlers register with onPluginSettingChanged, so you do not have to do it yourself.

-
-
Parameters
-
    -

  • plugin_name ā€“ Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a really good reason to access data of another mod AND if you can verify that plugin is actually installed.

    • -

  • key ā€“ Identifier of the setting.

    • -

  • value ā€“ New value for the setting.

    • -
-
-
-
- -
-
-startApplication(executable, args=[], cwd='', profile='', forcedCustomOverwrite='', ignoreCustomOverwrite=False)Ā¶
-

Starts an application with virtual filesystem active.

-
-
Parameters
-
    -

  • executable ā€“ Name or path of the executable. If this is only a filename, it will only work if it has been configured in MO as an executable. If it is a relative path it is expected to be relative to the game directory.

    • -

  • args ā€“ Arguments to pass to the executable. If the list is empty, and executable refers to a configured executable, the configured arguments are used.

    • -

  • cwd ā€“ The working directory for the executable. If this is empty, the path to the executable is used unless executable referred to a configured MO executable, in which case the configured cwd is used.

    • -

  • profile ā€“ Profile to use. If this is empty (the default) the current profile is used.

    • -

  • forcedCustomOverwrite ā€“ The mod to set as the custom overwrite, regardless of what the profile has configured.

    • -

  • ignoreCustomOverwrite ā€“ Set to true to ignore the profileā€™s configured custom overwrite.

    • -
-
-
Returns
-

The handle to the started application, or 0 if the application failed to start.

-
-
Return type
-

int

-
-
-
- -
-
-waitForApplication(handle)Ā¶
-

Wait for the application corresponding to the given handle to finish.

-

This will always show the lock overlay, regardless of whether the -user has disabled locking in the setting, so use this with care. -Note that the lock overlay will always allow the user to unlock, in -which case this will return False.

-
-
Parameters
-

handle ā€“ Handle of the application to wait for (as returned by startApplication()).

-
-
Returns
-

A tuple (result, exitcode), where result is a boolean indicating if the application

-
-
-

completed successfully, and exitcode is the exit code of the application.

-
-
Return type
-

Tuple[bool, int]

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IPlugin.html b/gh-pages/api/mobase.IPlugin.html deleted file mode 100644 index 91bc0ba..0000000 --- a/gh-pages/api/mobase.IPlugin.html +++ /dev/null @@ -1,482 +0,0 @@ - - - - - - - - - - IPlugin — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IPluginĀ¶

-
-
-class mobase.IPluginĀ¶
-

Bases: abc.ABC

-

Base class for all plugins.

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - -

author()

-
returns
-

The name of the plugin author.

-
-
-

description()

-
returns
-

The description for this plugin.

-
-
-

init(organizer)

Initialize this plugin.

isActive()

Check if this plugin is active.

name()

Retrieve the name of the plugin.

settings()

-
returns
-

A list of settings for this plugin.

-
-
-

version()

-
returns
-

The version of this plugin.

-
-
-

-

Methods Documentation

-
-
-abstract author()Ā¶
-
-
Returns
-

The name of the plugin author.

-
-
Return type
-

str

-
-
-
- -
-
-abstract description()Ā¶
-
-
Returns
-

The description for this plugin.

-
-
Return type
-

str

-
-
-
- -
-
-abstract init(organizer)Ā¶
-

Initialize this plugin.

-
-
Parameters
-

organizer ā€“ The main organizer interface.

-
-
Returns
-

True if the plugin was initialized correctly, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-abstract isActive()Ā¶
-

Check if this plugin is active.

-

It is possible to use a plugin setting (specified in settings()) here to allow -users to manually enable/disable a plugin.

-
-
Returns
-

True if this plugin is active, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-abstract name()Ā¶
-

Retrieve the name of the plugin.

-

The name of the plugin is used for internal storage purpose so it should not change, -and it should be static. In particular, you should not use a localized string (tr()) -for the plugin name.

-

In the future, we will provide a way to localized plugin names using a distinct method, -such as localizedName().

-
-
Returns
-

The name of the plugin.

-
-
Return type
-

str

-
-
-
- -
-
-abstract settings()Ā¶
-
-
Returns
-

A list of settings for this plugin.

-
-
Return type
-

List[PluginSetting]

-
-
-
- -
-
-abstract version()Ā¶
-
-
Returns
-

The version of this plugin.

-
-
Return type
-

VersionInfo

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IPluginDiagnose.html b/gh-pages/api/mobase.IPluginDiagnose.html deleted file mode 100644 index fcfa4e2..0000000 --- a/gh-pages/api/mobase.IPluginDiagnose.html +++ /dev/null @@ -1,449 +0,0 @@ - - - - - - - - - - IPluginDiagnose — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IPluginDiagnoseĀ¶

-
-
-class mobase.IPluginDiagnoseĀ¶
-

Bases: mobase.IPlugin

-

Plugins that create problem reports to be displayed in the UI.

-

This can be used to report problems related to the same plugin (which implements further -interfaces) or as a stand-alone diagnosis tool.

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - -

activeProblems()

Retrieve the list of active problems found by this plugin.

fullDescription(key)

Retrieve the full description of the problem corresponding to the given key.

hasGuidedFix(key)

Check if the problem corresponding to the given key has a guided fix.

shortDescription(key)

Retrieve the short description of the problem corresponding to the given key.

startGuidedFix(key)

Starts a guided fix for the problem corresponding to the given key.

-

Methods Documentation

-
-
-abstract activeProblems()Ā¶
-

Retrieve the list of active problems found by this plugin.

-

This method returns a list of problem IDs, that are then used when calling other methods -such as shortDescription() or hasGuidedFix().

-
-
Returns
-

The list of active problems for this plugin.

-
-
Return type
-

List[int]

-
-
-
- -
-
-abstract fullDescription(key)Ā¶
-

Retrieve the full description of the problem corresponding to the given key.

-
-
Parameters
-

key ā€“ ID of the problem.

-
-
Returns
-

The full description of the problem.

-
-
Raises
-

IndexError ā€“ If the key is not valid.

-
-
Return type
-

str

-
-
-
- -
-
-abstract hasGuidedFix(key)Ā¶
-

Check if the problem corresponding to the given key has a guided fix.

-
-
Parameters
-

key ā€“ ID of the problem.

-
-
Returns
-

True if there is a guided fix for the problem, False otherwise.

-
-
Raises
-

IndexError ā€“ If the key is not valid.

-
-
Return type
-

bool

-
-
-
- -
-
-abstract shortDescription(key)Ā¶
-

Retrieve the short description of the problem corresponding to the given key.

-
-
Parameters
-

key ā€“ ID of the problem.

-
-
Returns
-

The short description of the problem.

-
-
Raises
-

IndexError ā€“ If the key is not valid.

-
-
Return type
-

str

-
-
-
- -
-
-abstract startGuidedFix(key)Ā¶
-

Starts a guided fix for the problem corresponding to the given key.

-

This method should throw ValueError if there is no guided fix for the corresponding -problem.

-
-
Parameters
-

key ā€“ ID of the problem.

-
-
Raises
-
    -

  • IndexError ā€“ If the key is not valid.

    • -

  • ValueError ā€“ If there is no guided fix for this problem.

    • -
-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IPluginFileMapper.html b/gh-pages/api/mobase.IPluginFileMapper.html deleted file mode 100644 index 4eafb03..0000000 --- a/gh-pages/api/mobase.IPluginFileMapper.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - - - IPluginFileMapper — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IPluginFileMapperĀ¶

-
-
-class mobase.IPluginFileMapperĀ¶
-

Bases: mobase.IPlugin

-

Plugins that adds virtual file links.

-

Methods Summary

- ---- - - - - - -

mappings()

-
returns
-

Mapping for the virtual file system (VFS).

-
-
-

-

Methods Documentation

-
-
-abstract mappings()Ā¶
-
-
Returns
-

Mapping for the virtual file system (VFS).

-
-
Return type
-

List[Mapping]

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IPluginGame.html b/gh-pages/api/mobase.IPluginGame.html deleted file mode 100644 index a583d52..0000000 --- a/gh-pages/api/mobase.IPluginGame.html +++ /dev/null @@ -1,1045 +0,0 @@ - - - - - - - - - - IPluginGame — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IPluginGameĀ¶

-
-
-class mobase.IPluginGameĀ¶
-

Bases: mobase.IPlugin

-

Base classes for game plugins.

-

Each game requires a specific game plugin. These plugins were initially designed for -Bethesda games, so a lot of methods and attributes are irrelevant for other games. If -you wish to write a plugin for a much simpler game, please consider the basic_games -plugin: https://github.com/ModOrganizer2/modorganizer-basic_games

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

CCPlugins()

-
returns
-

The current list of active Creation Club plugins.

-
-
-

DLCPlugins()

-
returns
-

The list of esp/esm files that are part of known DLCs.

-
-
-

binaryName()

-
returns
-

The name of the default executable to run (relative to the game folder).

-
-
-

dataDirectory()

-
returns
-

The name of the directory containing data (relative to the game folder).

-
-
-

documentsDirectory()

-
returns
-

The directory of the documents folder where configuration files and such for this game reside.

-
-
-

executableForcedLoads()

-
returns
-

A list of automatically discovered libraries that can be force loaded with executables.

-
-
-

executables()

-
returns
-

A list of automatically discovered executables of the game itself and tools surrounding it.

-
-
-

feature(feature_type)

Retrieve a specified game feature from this plugin.

featureList()

Retrieve the list of game features implemented for this plugin.

gameDirectory()

-
returns
-

The directory containing the game installation.

-
-
-

gameIcon()

-
returns
-

The icon representing the game.

-
-
-

gameName()

-
returns
-

The name of the game (as displayed to the user).

-
-
-

gameNexusName()

-
returns
-

The name of the game identifier for Nexus.

-
-
-

gameShortName()

-
returns
-

The short name of the game.

-
-
-

gameVariants()

Retrieve the list of variants for this game.

gameVersion()

-
returns
-

The version of the game.

-
-
-

getLauncherName()

-
returns
-

The name of the launcher executable to run (relative to the game folder), or an

-
-
-

iniFiles()

-
returns
-

The list of INI files this game uses. The first file in the list should be the

-
-
-

initializeProfile(directory,Ā settings)

Initialize a profile for this game.

isInstalled()

-
returns
-

True if this game has been discovered as installed, False otherwise.

-
-
-

loadOrderMechanism()

-
returns
-

The load order mechanism used by this game.

-
-
-

looksValid(directory)

Check if the given directory looks like a valid game installation.

nexusGameID()

Retrieve the Nexus game ID for this game.

nexusModOrganizerID()

Retrieve the Nexus mod ID of Mod Organizer for this game.

primaryPlugins()

-
returns
-

The list of plugins that are part of the game and not considered optional.

-
-
-

primarySources()

Retrieve primary alternative ā€˜shortā€™ names for this game.

savegameExtension()

-
returns
-

The file extension of save games for this game.

-
-
-

savegameSEExtension()

-
returns
-

The file extension of Script Extender saves for this game.

-
-
-

savesDirectory()

-
returns
-

The directory where save games are stored.

-
-
-

setGamePath(path)

Set the path to the managed game.

setGameVariant(variant)

Set the game variant.

sortMechanism()

-
returns
-

The sort mechanism for this game.

-
-
-

steamAPPId()

Retrieve the Steam app ID for this game.

validShortNames()

Retrieve the valid ā€˜shortā€™ names for this game.

-

Methods Documentation

-
-
-abstract CCPlugins()Ā¶
-
-
Returns
-

The current list of active Creation Club plugins.

-
-
Return type
-

List[str]

-
-
-
- -
-
-abstract DLCPlugins()Ā¶
-
-
Returns
-

The list of esp/esm files that are part of known DLCs.

-
-
Return type
-

List[str]

-
-
-
- -
-
-abstract binaryName()Ā¶
-
-
Returns
-

The name of the default executable to run (relative to the game folder).

-
-
Return type
-

str

-
-
-
- -
-
-abstract dataDirectory()Ā¶
-
-
Returns
-

The name of the directory containing data (relative to the game folder).

-
-
Return type
-

QDir

-
-
-
- -
-
-abstract documentsDirectory()Ā¶
-
-
Returns
-

The directory of the documents folder where configuration files and such for this game reside.

-
-
Return type
-

QDir

-
-
-
- -
-
-abstract executableForcedLoads()Ā¶
-
-
Returns
-

A list of automatically discovered libraries that can be force loaded with executables.

-
-
Return type
-

List[ExecutableForcedLoadSetting]

-
-
-
- -
-
-abstract executables()Ā¶
-
-
Returns
-

A list of automatically discovered executables of the game itself and tools surrounding it.

-
-
Return type
-

List[ExecutableInfo]

-
-
-
- -
-
-feature(feature_type)Ā¶
-

Retrieve a specified game feature from this plugin.

-
-
Parameters
-

feature_type ā€“ The class of feature to retrieve.

-
-
Returns
-

The game feature corresponding to the given type, or None if the feature is

-
-
-

not implemented.

-
-
Return type
-

~GameFeatureType

-
-
-
- -
-
-featureList()Ā¶
-

Retrieve the list of game features implemented for this plugin.

-

Python plugin should not implement this method but _featureList().

-
-
Returns
-

A mapping from feature type to actual game features.

-
-
Return type
-

Dict[Type[~GameFeatureType], ~GameFeatureType]

-
-
-
- -
-
-abstract gameDirectory()Ā¶
-
-
Returns
-

The directory containing the game installation.

-
-
Return type
-

QDir

-
-
-
- -
-
-abstract gameIcon()Ā¶
-
-
Returns
-

The icon representing the game.

-
-
Return type
-

QIcon

-
-
-
- -
-
-abstract gameName()Ā¶
-
-
Returns
-

The name of the game (as displayed to the user).

-
-
Return type
-

str

-
-
-
- -
-
-abstract gameNexusName()Ā¶
-
-
Returns
-

The name of the game identifier for Nexus.

-
-
Return type
-

str

-
-
-
- -
-
-abstract gameShortName()Ā¶
-
-
Returns
-

The short name of the game.

-
-
Return type
-

str

-
-
-
- -
-
-abstract gameVariants()Ā¶
-

Retrieve the list of variants for this game.

-

If there are multiple variants of a game (and the variants make a difference to the -plugin), like a regular one and a GOTY-edition, the plugin can return a list of them -and the user gets to chose which one he owns.

-
-
Returns
-

The list of variants of the game.

-
-
Return type
-

List[str]

-
-
-
- -
-
-abstract gameVersion()Ā¶
-
-
Returns
-

The version of the game.

-
-
Return type
-

str

-
-
-
- -
-
-abstract getLauncherName()Ā¶
-
-
Returns
-

The name of the launcher executable to run (relative to the game folder), or an

-
-
-

empty string if there is no launcher.

-
-
Return type
-

str

-
-
-
- -
-
-abstract iniFiles()Ā¶
-
-
Returns
-

The list of INI files this game uses. The first file in the list should be the

-
-
-

ā€˜mainā€™ INI file.

-
-
Return type
-

List[str]

-
-
-
- -
-
-abstract initializeProfile(directory, settings)Ā¶
-

Initialize a profile for this game.

-

The MO app does not yet support virtualizing only specific aspects but plugins should be written -with this future functionality in mind.

-

This function will be used to initially create a profile, potentially to repair it or upgrade/downgrade -it so the implementations have to gracefully handle the case that the directory already contains files.

-
-
Parameters
-
    -

  • directory ā€“ The directory where the profile is to be initialized.

    • -

  • settings ā€“ The parameters for how the profile should be initialized.

    • -
-
-
-
- -
-
-abstract isInstalled()Ā¶
-
-
Returns
-

True if this game has been discovered as installed, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-abstract loadOrderMechanism()Ā¶
-
-
Returns
-

The load order mechanism used by this game.

-
-
Return type
-

LoadOrderMechanism

-
-
-
- -
-
-abstract looksValid(directory)Ā¶
-

Check if the given directory looks like a valid game installation.

-
-
Parameters
-

directory ā€“ Directory to check.

-
-
Returns
-

True if the directory looks like a valid installation of this game, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-abstract nexusGameID()Ā¶
-

Retrieve the Nexus game ID for this game.

-

Example: For Skyrim, the Nexus game ID is 110.

-
-
Returns
-

The Nexus game ID for this game.

-
-
Return type
-

int

-
-
-
- -
-
-abstract nexusModOrganizerID()Ā¶
-

Retrieve the Nexus mod ID of Mod Organizer for this game.

-
-
Example: For Skyrim SE, the mod ID of MO2 is 6194. You can find the mod ID in the URL:

https://www.nexusmods.com/skyrimspecialedition/mods/6194

-
-
-
-
Returns
-

The Nexus mod ID of Mod Organizer for this game.

-
-
Return type
-

int

-
-
-
- -
-
-abstract primaryPlugins()Ā¶
-
-
Returns
-

The list of plugins that are part of the game and not considered optional.

-
-
Return type
-

List[str]

-
-
-
- -
-
-abstract primarySources()Ā¶
-

Retrieve primary alternative ā€˜shortā€™ names for this game.

-

This is used to determine if a Nexus (or other) download source should be considered -as a primary source for the game so that it is not flagged as an alternative one.

-
-
Returns
-

The list of primary alternative ā€˜shortā€™ names for this game, or an empty list.

-
-
Return type
-

List[str]

-
-
-
- -
-
-abstract savegameExtension()Ā¶
-
-
Returns
-

The file extension of save games for this game.

-
-
Return type
-

str

-
-
-
- -
-
-abstract savegameSEExtension()Ā¶
-
-
Returns
-

The file extension of Script Extender saves for this game.

-
-
Return type
-

str

-
-
-
- -
-
-abstract savesDirectory()Ā¶
-
-
Returns
-

The directory where save games are stored.

-
-
Return type
-

QDir

-
-
-
- -
-
-abstract setGamePath(path)Ā¶
-

Set the path to the managed game.

-

This is called during instance creation if the game is not auto-detected and the user has -to specify the installation location. This is not called if the game has been auto-detected, -so isInstalled() should call this.

-
-
Parameters
-

path ā€“ Path to the game installation.

-
-
-
- -
-
-abstract setGameVariant(variant)Ā¶
-

Set the game variant.

-

If there are multiple variants of game (as returned by gameVariants()), this will be -called on start with the user-selected game variant.

-
-
Parameters
-

variant ā€“ The game variant selected by the user.

-
-
-
- -
-
-abstract sortMechanism()Ā¶
-
-
Returns
-

The sort mechanism for this game.

-
-
Return type
-

SortMechanism

-
-
-
- -
-
-abstract steamAPPId()Ā¶
-

Retrieve the Steam app ID for this game.

-

If the game is not available on Steam, this should return an empty string.

-

If a game is available in multiple versions, those might have different app ids. The plugin -should try to return the right one

-
-
Returns
-

The Steam app ID for this game. Should be empty for games not available on steam.

-
-
Return type
-

str

-
-
-
- -
-
-abstract validShortNames()Ā¶
-

Retrieve the valid ā€˜shortā€™ names for this game.

-

This is used to determine if a Nexus download is valid for the current game since not all -game variants have their own nexus pages and others can handle downloads from other nexus -game pages and should be allowed to do so (e.g., you can install some Skyrim LE mod even -when using Skyrim SE).

-

The short name should be considered the primary handler for a directly supported game -for puroses of auto-launching an instance.

-
-
Returns
-

The list of valid short names for this game.

-
-
Return type
-

List[str]

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IPluginInstaller.html b/gh-pages/api/mobase.IPluginInstaller.html deleted file mode 100644 index 02e79ff..0000000 --- a/gh-pages/api/mobase.IPluginInstaller.html +++ /dev/null @@ -1,432 +0,0 @@ - - - - - - - - - - IPluginInstaller — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IPluginInstallerĀ¶

-
-
-class mobase.IPluginInstallerĀ¶
-

Bases: mobase.IPlugin

-

This is the top-level class for installer. Actual installers should inherit either:

-
-
    -

  • IPluginInstallerSimple if the installer can work directly with the archive. This is what -most installers use.

    • -

  • IPluginInstallerCustom if the installer needs to perform custom operations. This is only -used by the external NCC installer and the OMOD installer.

    • -
-
-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - -

isArchiveSupported(tree)

Check if the given file tree corresponds to a supported archive for this installer.

isManualInstaller()

Check if this installer is a manual installer.

priority()

Retrieve the priority of this installer.

setInstallationManager(manager)

Set the installation manager for this installer.

setParentWidget(parent)

Set the parent widget for this installer.

-

Methods Documentation

-
-
-abstract isArchiveSupported(tree)Ā¶
-

Check if the given file tree corresponds to a supported archive for this installer.

-
-
Parameters
-

tree ā€“ The tree representing the content of the archive.

-
-
Returns
-

True if this installer can handle the archive, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-abstract isManualInstaller()Ā¶
-

Check if this installer is a manual installer.

-
-
Returns
-

True if this installer is a manual installer, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-abstract priority()Ā¶
-

Retrieve the priority of this installer.

-

If multiple installers are able to handle an archive, the one with the highest priority wins.

-
-
Returns
-

The priority of this installer.

-
-
Return type
-

int

-
-
-
- -
-
-setInstallationManager(manager)Ā¶
-

Set the installation manager for this installer.

-

Python plugins usually do not need to re-implement this and can directly access the installation -manager using _manager().

-
-
Parameters
-

manager ā€“ The installation manager.

-
-
-
- -
-
-setParentWidget(parent)Ā¶
-

Set the parent widget for this installer.

-

Python plugins usually do not need to re-implement this and can directly access the parent -widget using _parentWidget() once the UI has been initialized.

-
-
Parameters
-

parent ā€“ The parent widget.

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IPluginInstallerCustom.html b/gh-pages/api/mobase.IPluginInstallerCustom.html deleted file mode 100644 index 2754448..0000000 --- a/gh-pages/api/mobase.IPluginInstallerCustom.html +++ /dev/null @@ -1,396 +0,0 @@ - - - - - - - - - - IPluginInstallerCustom — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IPluginInstallerCustomĀ¶

-
-
-class mobase.IPluginInstallerCustomĀ¶
-

Bases: mobase.IPluginInstaller

-

Custom installer for mods. Custom installers receive the archive name and have to go -from there. They have to be able to extract the archive themself.

-

Example of such installers are the external NCC installer or the OMOD installer.

-

Methods Summary

- ---- - - - - - - - - - - - -

install(mod_name,Ā game_name,Ā archive_name,Ā ā€¦)

Install the given archive.

isArchiveSupported(**kwds)

Helper for @overload to raise when called.

supportedExtensions()

-
returns
-

A list of file extensions that this installer can handle.

-
-
-

-

Methods Documentation

-
-
-abstract install(mod_name, game_name, archive_name, version, nexus_id)Ā¶
-

Install the given archive.

-

The mod needs to be created by calling IOrganizer.createMod first.

-
-
Parameters
-
    -

  • mod_name ā€“ Name of the mod to install. As an input parameter this is the suggested name (e.g. from meta data) The installer may change this parameter to rename the mod).

    • -

  • game_name ā€“ Name of the game for which the mod is installed.

    • -

  • archive_name ā€“ Name of the archive to install.

    • -

  • version ā€“ Version of the mod. May be empty if the version is not yet known. The plugin is responsible for setting the version on the created mod.

    • -

  • nexus_id ā€“ ID of the mod or -1 if unknown. The plugin is responsible for setting the mod ID for the created mod.

    • -
-
-
Returns
-

The result of the installation process.

-
-
Return type
-

InstallResult

-
-
-
- -
-
-isArchiveSupported(**kwds)Ā¶
-

Helper for @overload to raise when called.

-
- -
-
-abstract supportedExtensions()Ā¶
-
-
Returns
-

A list of file extensions that this installer can handle.

-
-
Return type
-

List[str]

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IPluginInstallerSimple.html b/gh-pages/api/mobase.IPluginInstallerSimple.html deleted file mode 100644 index 3dec216..0000000 --- a/gh-pages/api/mobase.IPluginInstallerSimple.html +++ /dev/null @@ -1,374 +0,0 @@ - - - - - - - - - - IPluginInstallerSimple — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IPluginInstallerSimpleĀ¶

-
-
-class mobase.IPluginInstallerSimpleĀ¶
-

Bases: mobase.IPluginInstaller

-

Simple installer for mods. Simple installers only deal with an in-memory structure -representing the archive and can modify what to install and where by editing this structure. -Actually extracting the archive is handled by the manager.

-

Methods Summary

- ---- - - - - - -

install(name,Ā tree,Ā version,Ā nexus_id)

Install a mod from an archive filetree.

-

Methods Documentation

-
-
-abstract install(name, tree, version, nexus_id)Ā¶
-

Install a mod from an archive filetree.

-

The installer can modify the given tree and use the manager to extract or create new -files.

-

This method returns different type of objects depending on the actual result of the -installation. The C++ bindings for this method always returns a tuple (result, tree, -version, id).

-
-
Parameters
-
    -

  • name ā€“ Name of the mod to install. As an input parameter this is the suggested name (e.g. from meta data) The installer may change this parameter to rename the mod).

    • -

  • tree ā€“ In-memory representation of the archive content.

    • -

  • version ā€“ Version of the mod, or an empty string is unknown.

    • -

  • nexus_id ā€“ ID of the mod, or -1 if unknown.

    • -
-
-
Returns
-

In case of failure, the result of the installation, otherwise the modified tree or

-
-
-

a tuple (result, tree, version, id) containing the result of the installation, the -modified tree, the new version and the new ID. The tuple can be returned even if the -installation did not succeed.

-
-
Return type
-

Union[InstallResult, IFileTree, Tuple[InstallResult, IFileTree, str, int]]

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IPluginList.html b/gh-pages/api/mobase.IPluginList.html deleted file mode 100644 index 2a5389b..0000000 --- a/gh-pages/api/mobase.IPluginList.html +++ /dev/null @@ -1,559 +0,0 @@ - - - - - - - - - - IPluginList — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IPluginListĀ¶

-
-
-class mobase.IPluginListĀ¶
-

Bases: object

-

Primary interface to the list of plugins.

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

isMaster(name)

Check if a plugin is a master file (basically a library, referenced by other plugins).

loadOrder(name)

Retrieve the load order of a plugin.

masters(name)

Retrieve the list of masters required for a plugin.

onPluginMoved(callback)

Install a new handler to be called when a plugin is moved.

onRefreshed(callback)

Install a new handler to be called when the list of plugins is refreshed.

origin(name)

Retrieve the origin of a plugin.

pluginNames()

-
returns
-

The list of all plugin names.

-
-
-

priority(name)

Retrieve the priority of a plugin.

setLoadOrder(loadorder)

Set the load order.

setState(name,Ā state)

Set the state of a plugin.

state(name)

Retrieve the state of a plugin.

-

Methods Documentation

-
-
-isMaster(name)Ā¶
-

Check if a plugin is a master file (basically a library, referenced by other plugins).

-

In gamebryo games, a master file will usually have a .esm file extension but technically -an esp can be flagged as master and an esm might not be.

-
-
Parameters
-

name ā€“ Filename of the plugin (without path but with file extension).

-
-
Returns
-

True if the given plugin is a master plugin, False otherwise or if the file does not exist.

-
-
Return type
-

bool

-
-
-
- -
-
-loadOrder(name)Ā¶
-

Retrieve the load order of a plugin.

-
-
Parameters
-

name ā€“ Filename of the plugin (without path but with file extension).

-
-
Returns
-

The load order of the plugin (the order in which the game loads it). If all plugins are enabled this

-
-
-

is the same as the priority but disabled plugins will have a load order of -1. This also returns -1 -if the plugin does not exist.

-
-
Return type
-

int

-
-
-
- -
-
-masters(name)Ā¶
-

Retrieve the list of masters required for a plugin.

-
-
Parameters
-

name ā€“ Filename of the plugin (without path but with file extension).

-
-
Returns
-

The list of masters for the plugin (filenames with extension, no path).

-
-
Return type
-

List[str]

-
-
-
- -
-
-onPluginMoved(callback)Ā¶
-

Install a new handler to be called when a plugin is moved.

-
-
Parameters
-

callback ā€“ The function to call when a plugin is moved. The first parameter is the plugin name, the second the old priority of the plugin and the third one the new priority.

-
-
Returns
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
Return type
-

bool

-
-
-
- -
-
-onRefreshed(callback)Ā¶
-

Install a new handler to be called when the list of plugins is refreshed.

-
-
Parameters
-

callback ā€“ The function to call when the list of plugins is refreshed.

-
-
Returns
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
Return type
-

bool

-
-
-
- -
-
-origin(name)Ā¶
-

Retrieve the origin of a plugin. This is either the (internal) name of a mod, ā€œoverwriteā€ or ā€œdataā€.

-

The internal name of a mod can differ from the display name for disambiguation.

-
-
Parameters
-

name ā€“ Filename of the plugin (without path but with file extension).

-
-
Returns
-

The name of the origin of the plugin, or an empty string if the plugin does not exist.

-
-
Return type
-

str

-
-
-
- -
-
-pluginNames()Ā¶
-
-
Returns
-

The list of all plugin names.

-
-
Return type
-

List[str]

-
-
-
- -
-
-priority(name)Ā¶
-

Retrieve the priority of a plugin.

-

The higher the priority, the more important.

-
-
Parameters
-

name ā€“ Filename of the plugin (without path but with file extension).

-
-
Returns
-

The priority of the given plugin, or -1 if the plugin does not exist.

-
-
Return type
-

int

-
-
-
- -
-
-setLoadOrder(loadorder)Ā¶
-

Set the load order.

-

Plugins not included in the list will be placed at highest priority in the order they -were before.

-
-
Parameters
-

loadorder ā€“ The new load order, specified by the list of plugin names, sorted.

-
-
-
- -
-
-setState(name, state)Ā¶
-

Set the state of a plugin.

-
-
Parameters
-
    -

  • name ā€“ Filename of the plugin (without path but with file extension).

    • -

  • state ā€“ New state of the plugin (INACTIVE or ACTIVE).

    • -
-
-
-
- -
-
-state(name)Ā¶
-

Retrieve the state of a plugin.

-
-
Parameters
-

name ā€“ Filename of the plugin (without path but with file extension).

-
-
Returns
-

The state of the plugin.

-
-
Return type
-

int

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IPluginModPage.html b/gh-pages/api/mobase.IPluginModPage.html deleted file mode 100644 index e8762f4..0000000 --- a/gh-pages/api/mobase.IPluginModPage.html +++ /dev/null @@ -1,458 +0,0 @@ - - - - - - - - - - IPluginModPage — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IPluginModPageĀ¶

-
-
-class mobase.IPluginModPageĀ¶
-

Bases: mobase.IPlugin

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - -

displayName()

-
returns
-

The name of the page as displayed in the UI.

-
-
-

handlesDownload(page_url,Ā download_url,Ā fileinfo)

Check if the plugin handles the specified download.

icon()

-
returns
-

The icon to display with the page.

-
-
-

pageURL()

-
returns
-

The URL to open when the user wants to visit this mod page.

-
-
-

setParentWidget(parent)

Set the parent widget for this mod page.

useIntegratedBrowser()

Indicates if the page should be displayed in the integrated browser.

-

Methods Documentation

-
-
-abstract displayName()Ā¶
-
-
Returns
-

The name of the page as displayed in the UI.

-
-
Return type
-

str

-
-
-
- -
-
-abstract handlesDownload(page_url, download_url, fileinfo)Ā¶
-

Check if the plugin handles the specified download.

-
-
Parameters
-
    -

  • page_url ā€“ URL of the page that contains the download link.

    • -

  • download_url ā€“ The download URL.

    • -

  • fileinfo ā€“ Not usable in python.

    • -
-
-
Returns
-

True if this plugin wants to handle the specified download, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-abstract icon()Ā¶
-
-
Returns
-

The icon to display with the page.

-
-
Return type
-

QIcon

-
-
-
- -
-
-abstract pageURL()Ā¶
-
-
Returns
-

The URL to open when the user wants to visit this mod page.

-
-
Return type
-

QUrl

-
-
-
- -
-
-setParentWidget(parent)Ā¶
-

Set the parent widget for this mod page.

-

Python plugins usually do not need to re-implement this and can directly access the parent -widget using _parentWidget() once the UI has been initialized.

-
-
Parameters
-

parent ā€“ The parent widget.

-
-
-
- -
-
-abstract useIntegratedBrowser()Ā¶
-

Indicates if the page should be displayed in the integrated browser.

-

Unless the page provides a special means of starting downloads (like the nxm:// url schema -on nexus), it will not be possible to handle downloads unless the integrated browser is used!

-
-
Returns
-

True if the page should be opened in the integrated browser, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IPluginPreview.html b/gh-pages/api/mobase.IPluginPreview.html deleted file mode 100644 index 115cdaf..0000000 --- a/gh-pages/api/mobase.IPluginPreview.html +++ /dev/null @@ -1,382 +0,0 @@ - - - - - - - - - - IPluginPreview — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IPluginPreviewĀ¶

-
-
-class mobase.IPluginPreviewĀ¶
-

Bases: mobase.IPlugin

-

These plugins add support for previewing files in the data pane. Right now all image formats supported -by qt are implemented (including dds) but no audio files and no 3d mesh formats.

-

Methods Summary

- ---- - - - - - - - - -

genFilePreview(filename,Ā max_size)

Generate a preview for the specified file.

supportedExtensions()

-
returns
-

The list of file extensions that are supported by this preview plugin.

-
-
-

-

Methods Documentation

-
-
-abstract genFilePreview(filename, max_size)Ā¶
-

Generate a preview for the specified file.

-
-
Parameters
-
    -

  • filename ā€“ Path to the file to preview.

    • -

  • max_size ā€“ Maximum size of the generated widget.

    • -
-
-
Returns
-

The widget showing a preview of the file.

-
-
Return type
-

QWidget

-
-
-
- -
-
-abstract supportedExtensions()Ā¶
-
-
Returns
-

The list of file extensions that are supported by this preview plugin.

-
-
Return type
-

List[str]

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IPluginTool.html b/gh-pages/api/mobase.IPluginTool.html deleted file mode 100644 index 5328cef..0000000 --- a/gh-pages/api/mobase.IPluginTool.html +++ /dev/null @@ -1,430 +0,0 @@ - - - - - - - - - - IPluginTool — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IPluginToolĀ¶

-
-
-class mobase.IPluginToolĀ¶
-

Bases: mobase.IPlugin

-

This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools submenu -and get invoked when the user clicks it. They are expected to have a user interface of some sort. These -are almost like independent applications except they can access all Mod Organizer interfaces like querying -and modifying the current profile, mod list, load order, use MO to install mods and so on. A tool plugin -can (and should!) integrate its UI as a window inside MO and thus doesnā€™t have to initialize a windows -application itself.

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - -

display()

Called when the user starts the tool.

displayName()

-
returns
-

The display name for this tool, as shown in the tool menu.

-
-
-

icon()

-
returns
-

The icon for this tool, or a default-constructed QICon().

-
-
-

setParentWidget(parent)

Set the parent widget for this tool.

tooltip()

-
returns
-

The tooltip for this tool.

-
-
-

-

Methods Documentation

-
-
-abstract display()Ā¶
-

Called when the user starts the tool.

-
- -
-
-abstract displayName()Ā¶
-
-
Returns
-

The display name for this tool, as shown in the tool menu.

-
-
Return type
-

str

-
-
-
- -
-
-abstract icon()Ā¶
-
-
Returns
-

The icon for this tool, or a default-constructed QICon().

-
-
Return type
-

QIcon

-
-
-
- -
-
-setParentWidget(parent)Ā¶
-

Set the parent widget for this tool.

-

Python plugins usually do not need to re-implement this and can directly access the parent -widget using _parentWidget() once the UI has been initialized.

-
-
Parameters
-

parent ā€“ The parent widget.

-
-
-
- -
-
-abstract tooltip()Ā¶
-
-
Returns
-

The tooltip for this tool.

-
-
Return type
-

str

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.IProfile.html b/gh-pages/api/mobase.IProfile.html deleted file mode 100644 index fa9fc6d..0000000 --- a/gh-pages/api/mobase.IProfile.html +++ /dev/null @@ -1,426 +0,0 @@ - - - - - - - - - - IProfile — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

IProfileĀ¶

-
-
-class mobase.IProfileĀ¶
-

Bases: object

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - -

absolutePath()

-
rtype
-

str

-
-
-

invalidationActive()

-
rtype
-

Tuple[bool, bool]

-
-
-

localSavesEnabled()

-
rtype
-

bool

-
-
-

localSettingsEnabled()

-
rtype
-

bool

-
-
-

name()

-
rtype
-

str

-
-
-

-

Methods Documentation

-
-
-absolutePath()Ā¶
-
-
Return type
-

str

-
-
-
- -
-
-invalidationActive()Ā¶
-
-
Return type
-

Tuple[bool, bool]

-
-
-
- -
-
-localSavesEnabled()Ā¶
-
-
Return type
-

bool

-
-
-
- -
-
-localSettingsEnabled()Ā¶
-
-
Return type
-

bool

-
-
-
- -
-
-name()Ā¶
-
-
Return type
-

str

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.ISaveGame.html b/gh-pages/api/mobase.ISaveGame.html deleted file mode 100644 index 6f3c518..0000000 --- a/gh-pages/api/mobase.ISaveGame.html +++ /dev/null @@ -1,438 +0,0 @@ - - - - - - - - - - ISaveGame — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ISaveGameĀ¶

-
-
-class mobase.ISaveGameĀ¶
-

Bases: object

-

Base class for information about what is in a save game.

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - -

allFiles()

-
returns
-

The list of all files related to this save.

-
-
-

getCreationTime()

Retrieve the creation time of the save.

getFilename()

-
returns
-

The name of the (main) save file.

-
-
-

getSaveGroupIdentifier()

Retrieve the name of the group this files belong to.

hasScriptExtenderFile()

-
returns
-

True if this save game has an associated script extender save, False otherwise.

-
-
-

-

Methods Documentation

-
-
-allFiles()Ā¶
-
-
Returns
-

The list of all files related to this save.

-
-
Return type
-

List[str]

-
-
-
- -
-
-getCreationTime()Ā¶
-

Retrieve the creation time of the save.

-

The creation time of a save is not always the same as the creation time of -the file containing the save.

-
-
Returns
-

The creation time of the save.

-
-
Return type
-

QDateTime

-
-
-
- -
-
-getFilename()Ā¶
-
-
Returns
-

The name of the (main) save file.

-
-
Return type
-

str

-
-
-
- -
-
-getSaveGroupIdentifier()Ā¶
-

Retrieve the name of the group this files belong to.

-

The name can be used to identify sets of saves to transfer between profiles. For -RPG games, this is usually the name of a character.

-
-
Returns
-

The group identifier for this save game.

-
-
Return type
-

str

-
-
-
- -
-
-hasScriptExtenderFile()Ā¶
-
-
Returns
-

True if this save game has an associated script extender save, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.ISaveGameInfoWidget.html b/gh-pages/api/mobase.ISaveGameInfoWidget.html deleted file mode 100644 index 2d1e444..0000000 --- a/gh-pages/api/mobase.ISaveGameInfoWidget.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - - - - - - - ISaveGameInfoWidget — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ISaveGameInfoWidgetĀ¶

-
-
-class mobase.ISaveGameInfoWidget(parent=None)Ā¶
-

Bases: PyQt5.QtWidgets.QWidget

-

Base class for a save game info widget.

-

Methods Summary

- ---- - - - - - -

setSave(save)

Set the save file to display in this widget.

-

Methods Documentation

-
-
-abstract setSave(save)Ā¶
-

Set the save file to display in this widget.

-
-
Parameters
-

save ā€“ Path to the save file.

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.InstallResult.html b/gh-pages/api/mobase.InstallResult.html deleted file mode 100644 index a9e6c0a..0000000 --- a/gh-pages/api/mobase.InstallResult.html +++ /dev/null @@ -1,377 +0,0 @@ - - - - - - - - - - InstallResult — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

InstallResultĀ¶

-
-
-class mobase.InstallResultĀ¶
-

Bases: enum.Enum

-

An enumeration.

-

Attributes Summary

- ---- - - - - - - - - - - - - - - - - - -

CANCELED

FAILED

MANUAL_REQUESTED

NOT_ATTEMPTED

SUCCESS

-

Attributes Documentation

-
-
-CANCELED = EllipsisĀ¶
-
- -
-
-FAILED = EllipsisĀ¶
-
- -
-
-MANUAL_REQUESTED = EllipsisĀ¶
-
- -
-
-NOT_ATTEMPTED = EllipsisĀ¶
-
- -
-
-SUCCESS = EllipsisĀ¶
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.InterfaceNotImplemented.html b/gh-pages/api/mobase.InterfaceNotImplemented.html deleted file mode 100644 index 0a6c760..0000000 --- a/gh-pages/api/mobase.InterfaceNotImplemented.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - InterfaceNotImplemented — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

InterfaceNotImplementedĀ¶

-
-
-class mobase.InterfaceNotImplementedĀ¶
-

Bases: object

-
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.LoadOrderMechanism.html b/gh-pages/api/mobase.LoadOrderMechanism.html deleted file mode 100644 index 1e1670e..0000000 --- a/gh-pages/api/mobase.LoadOrderMechanism.html +++ /dev/null @@ -1,353 +0,0 @@ - - - - - - - - - - LoadOrderMechanism — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

LoadOrderMechanismĀ¶

-
-
-class mobase.LoadOrderMechanismĀ¶
-

Bases: enum.Enum

-

An enumeration.

-

Attributes Summary

- ---- - - - - - - - - -

FILE_TIME

PLUGINS_TXT

-

Attributes Documentation

-
-
-FILE_TIME = EllipsisĀ¶
-
- -
-
-PLUGINS_TXT = EllipsisĀ¶
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.LocalSavegames.html b/gh-pages/api/mobase.LocalSavegames.html deleted file mode 100644 index ca29968..0000000 --- a/gh-pages/api/mobase.LocalSavegames.html +++ /dev/null @@ -1,372 +0,0 @@ - - - - - - - - - - LocalSavegames — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

LocalSavegamesĀ¶

-
-
-class mobase.LocalSavegamesĀ¶
-

Bases: abc.ABC

-

Methods Summary

- ---- - - - - - - - - -

mappings(profile_save_dir)

-
rtype
-

List[Mapping]

-
-
-

prepareProfile(profile)

-
rtype
-

bool

-
-
-

-

Methods Documentation

-
-
-abstract mappings(profile_save_dir)Ā¶
-
-
Return type
-

List[Mapping]

-
-
-
- -
-
-abstract prepareProfile(profile)Ā¶
-
-
Return type
-

bool

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.Mapping.html b/gh-pages/api/mobase.Mapping.html deleted file mode 100644 index 6f49f2d..0000000 --- a/gh-pages/api/mobase.Mapping.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - - Mapping — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

MappingĀ¶

-
-
-class mobase.MappingĀ¶
-

Bases: object

-

Attributes Summary

- ---- - - - - - - - - - - - - - - -

createTarget

bool

destination

str

isDirectory

bool

source

str

-

Attributes Documentation

-
-
-createTargetĀ¶
-

bool

-
-
Type
-

rtype

-
-
-
- -
-
-destinationĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
-
-isDirectoryĀ¶
-

bool

-
-
Type
-

rtype

-
-
-
- -
-
-sourceĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.ModDataChecker.html b/gh-pages/api/mobase.ModDataChecker.html deleted file mode 100644 index 9ebb63f..0000000 --- a/gh-pages/api/mobase.ModDataChecker.html +++ /dev/null @@ -1,422 +0,0 @@ - - - - - - - - - - ModDataChecker — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ModDataCheckerĀ¶

-
-
-class mobase.ModDataCheckerĀ¶
-

Bases: abc.ABC

-

Game feature that is used to check the content of a data tree.

-

Attributes Summary

- ---- - - - - - - - - - - - -

FIXABLE

INVALID

VALID

-

Methods Summary

- ---- - - - - - - - - -

dataLooksValid(filetree)

Check that the given filetree represent a valid mod layout, or can be easily fixed.

fix(filetree)

Try to fix the given tree.

-

Attributes Documentation

-
-
-FIXABLE: ModDataChecker.CheckReturn = EllipsisĀ¶
-
- -
-
-INVALID: ModDataChecker.CheckReturn = EllipsisĀ¶
-
- -
-
-VALID: ModDataChecker.CheckReturn = EllipsisĀ¶
-
- -

Methods Documentation

-
-
-abstract dataLooksValid(filetree)Ā¶
-

Check that the given filetree represent a valid mod layout, or can be easily -fixed.

-

This method is mainly used during installation (to find which installer should -be used or to recurse into multi-level archives), or to quickly indicates to a -user if a mod looks valid.

-

This method does not have to be exact, it only has to indicate if the given tree -looks like a valid mod or not by quickly checking the structure (heavy operations -should be avoided).

-

If the tree can be fixed by the fix() method, this method should return FIXABLE. -FIXABLE should only be returned when it is guaranteed that fix() can fix the tree.

-
-
Parameters
-

filetree ā€“ The tree starting at the root of the ā€œdataā€ folder.

-
-
Returns
-

Whether the tree is invalid, fixable or valid.

-
-
Return type
-

CheckReturn

-
-
-
- -
-
-fix(filetree)Ā¶
-

Try to fix the given tree.

-

This method is used during installation to try to fix invalid archives and will only be -called if dataLooksValid returned FIXABLE.

-
-
Parameters
-

filetree ā€“ The tree to try to fix. Can be modified during the process.

-
-
Returns
-

The fixed tree, or a null pointer if the tree could not be fixed.

-
-
Return type
-

Optional[IFileTree]

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.ModDataContent.html b/gh-pages/api/mobase.ModDataContent.html deleted file mode 100644 index 95c4f53..0000000 --- a/gh-pages/api/mobase.ModDataContent.html +++ /dev/null @@ -1,408 +0,0 @@ - - - - - - - - - - ModDataContent — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ModDataContentĀ¶

-
-
-class mobase.ModDataContentĀ¶
-

Bases: abc.ABC

-

The ModDataContent feature is used (when available) to indicate to users the content -of mods in the ā€œContentā€ column.

-

The feature exposes a list of possible content types, each associated with an ID, a name -and an icon. The icon is the path to either:

-
-
    -

  • A Qt resource or;

    • -

  • A file on the disk.

    • -
-
-

In order to facilitate the implementation, MO2 already provides a set of icons that can -be used. Those icons are all under :/MO/gui/content (e.g. :/MO/gui/content/plugin or :/MO/gui/content/music `).

-

The list of available icons is:

-
-
    -

  • plugin: plugin-icon

    • -

  • skyproc: skyproc-icon

    • -

  • texture: texture-icon

    • -

  • music: music-icon

    • -

  • sound: sound-icon

    • -

  • interface: interface-icon

    • -

  • skse: skse-icon

    • -

  • script: script-icon

    • -

  • mesh: mesh-icon

    • -

  • string: string-icon

    • -

  • bsa: bsa-icon

    • -

  • menu: menu-icon

    • -

  • inifile: inifile-icon

    • -

  • modgroup: modgroup-icon

    • -
-
-

Methods Summary

- ---- - - - - - - - - -

getAllContents()

-
returns
-

The list of all possible contents for the corresponding game.

-
-
-

getContentsFor(filetree)

Retrieve the list of contents in the given tree.

-

Methods Documentation

-
-
-abstract getAllContents()Ā¶
-
-
Returns
-

The list of all possible contents for the corresponding game.

-
-
Return type
-

List[Content]

-
-
-
- -
-
-abstract getContentsFor(filetree)Ā¶
-

Retrieve the list of contents in the given tree.

-
-
Parameters
-

filetree ā€“ The tree corresponding to the mod to retrieve contents for.

-
-
Returns
-

The IDs of the content in the given tree.

-
-
Return type
-

List[int]

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.ModRepositoryFileInfo.html b/gh-pages/api/mobase.ModRepositoryFileInfo.html deleted file mode 100644 index 750af6b..0000000 --- a/gh-pages/api/mobase.ModRepositoryFileInfo.html +++ /dev/null @@ -1,588 +0,0 @@ - - - - - - - - - - ModRepositoryFileInfo — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ModRepositoryFileInfoĀ¶

-
-
-class mobase.ModRepositoryFileInfo(**kwds)Ā¶
-

Bases: object

-

Attributes Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

categoryID

int

description

str

fileCategory

int

fileID

int

fileName

str

fileSize

int

fileTime

QDateTime

gameName

str

modID

int

modName

str

name

str

newestVersion

VersionInfo

repository

str

uri

str

userData

Union[None, bool, int, str, List[Any], Dict[str, Any]]

version

VersionInfo

-

Methods Summary

- ---- - - - - - -

createFromJson(data)

-
rtype
-

ModRepositoryFileInfo

-
-
-

-

Attributes Documentation

-
-
-categoryIDĀ¶
-

int

-
-
Type
-

rtype

-
-
-
- -
-
-descriptionĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
-
-fileCategoryĀ¶
-

int

-
-
Type
-

rtype

-
-
-
- -
-
-fileIDĀ¶
-

int

-
-
Type
-

rtype

-
-
-
- -
-
-fileNameĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
-
-fileSizeĀ¶
-

int

-
-
Type
-

rtype

-
-
-
- -
-
-fileTimeĀ¶
-

QDateTime

-
-
Type
-

rtype

-
-
-
- -
-
-gameNameĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
-
-modIDĀ¶
-

int

-
-
Type
-

rtype

-
-
-
- -
-
-modNameĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
-
-nameĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
-
-newestVersionĀ¶
-

VersionInfo

-
-
Type
-

rtype

-
-
-
- -
-
-repositoryĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
-
-uriĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
-
-userDataĀ¶
-

Union[None, bool, int, str, List[Any], Dict[str, Any]]

-
-
Type
-

rtype

-
-
-
- -
-
-versionĀ¶
-

VersionInfo

-
-
Type
-

rtype

-
-
-
- -

Methods Documentation

-
-
-static createFromJson(data)Ā¶
-
-
Return type
-

ModRepositoryFileInfo

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.ModState.html b/gh-pages/api/mobase.ModState.html deleted file mode 100644 index 7748042..0000000 --- a/gh-pages/api/mobase.ModState.html +++ /dev/null @@ -1,393 +0,0 @@ - - - - - - - - - - ModState — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ModStateĀ¶

-
-
-class mobase.ModStateĀ¶
-

Bases: enum.Enum

-

An enumeration.

-

Attributes Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - -

ACTIVE

ALTERNATE

EMPTY

ENDORSED

ESSENTIAL

EXISTS

VALID

-

Attributes Documentation

-
-
-ACTIVE = EllipsisĀ¶
-
- -
-
-ALTERNATE = EllipsisĀ¶
-
- -
-
-EMPTY = EllipsisĀ¶
-
- -
-
-ENDORSED = EllipsisĀ¶
-
- -
-
-ESSENTIAL = EllipsisĀ¶
-
- -
-
-EXISTS = EllipsisĀ¶
-
- -
-
-VALID = EllipsisĀ¶
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.PluginSetting.html b/gh-pages/api/mobase.PluginSetting.html deleted file mode 100644 index 9cdcf50..0000000 --- a/gh-pages/api/mobase.PluginSetting.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - - - - - PluginSetting — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

PluginSettingĀ¶

-
-
-class mobase.PluginSetting(key, description, default_value)Ā¶
-

Bases: object

-

Class to hold the user-configurable parameters a plugin accepts. The purpose of this class is -only to inform the application what settings to offer to the user, it does not hold the actual value.

-

Attributes Summary

- ---- - - - - - - - - - - - -

default_value

Union[None, bool, int, str, List[Any], Dict[str, Any]]

description

str

key

str

-

Attributes Documentation

-
-
-default_valueĀ¶
-

Union[None, bool, int, str, List[Any], Dict[str, Any]]

-
-
Type
-

rtype

-
-
-
- -
-
-descriptionĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
-
-keyĀ¶
-

str

-
-
Type
-

rtype

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.PluginState.html b/gh-pages/api/mobase.PluginState.html deleted file mode 100644 index 2c19255..0000000 --- a/gh-pages/api/mobase.PluginState.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - - - - - - PluginState — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

PluginStateĀ¶

-
-
-class mobase.PluginStateĀ¶
-

Bases: enum.Enum

-

An enumeration.

-

Attributes Summary

- ---- - - - - - - - - - - - -

ACTIVE

INACTIVE

MISSING

-

Attributes Documentation

-
-
-ACTIVE = EllipsisĀ¶
-
- -
-
-INACTIVE = EllipsisĀ¶
-
- -
-
-MISSING = EllipsisĀ¶
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.ProfileSetting.html b/gh-pages/api/mobase.ProfileSetting.html deleted file mode 100644 index 170ade9..0000000 --- a/gh-pages/api/mobase.ProfileSetting.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - - - - - - - ProfileSetting — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ProfileSettingĀ¶

-
-
-class mobase.ProfileSettingĀ¶
-

Bases: enum.Enum

-

An enumeration.

-

Attributes Summary

- ---- - - - - - - - - - - - - - - -

CONFIGURATION

MODS

PREFER_DEFAULTS

SAVEGAMES

-

Attributes Documentation

-
-
-CONFIGURATION = EllipsisĀ¶
-
- -
-
-MODS = EllipsisĀ¶
-
- -
-
-PREFER_DEFAULTS = EllipsisĀ¶
-
- -
-
-SAVEGAMES = EllipsisĀ¶
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.ReleaseType.html b/gh-pages/api/mobase.ReleaseType.html deleted file mode 100644 index bfd500c..0000000 --- a/gh-pages/api/mobase.ReleaseType.html +++ /dev/null @@ -1,377 +0,0 @@ - - - - - - - - - - ReleaseType — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ReleaseTypeĀ¶

-
-
-class mobase.ReleaseTypeĀ¶
-

Bases: enum.Enum

-

An enumeration.

-

Attributes Summary

- ---- - - - - - - - - - - - - - - - - - -

ALPHA

BETA

CANDIDATE

FINAL

PRE_ALPHA

-

Attributes Documentation

-
-
-ALPHA = EllipsisĀ¶
-
- -
-
-BETA = EllipsisĀ¶
-
- -
-
-CANDIDATE = EllipsisĀ¶
-
- -
-
-FINAL = EllipsisĀ¶
-
- -
-
-PRE_ALPHA = EllipsisĀ¶
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.SaveGameInfo.html b/gh-pages/api/mobase.SaveGameInfo.html deleted file mode 100644 index 934a6f5..0000000 --- a/gh-pages/api/mobase.SaveGameInfo.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - SaveGameInfo — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

SaveGameInfoĀ¶

-
-
-class mobase.SaveGameInfoĀ¶
-

Bases: abc.ABC

-

Feature to get hold of stuff to do with save games.

-

Methods Summary

- ---- - - - - - - - - - - - - - - -

getMissingAssets(filepath)

Retrieve missing assets from the save.

getSaveGameInfo(filepath)

Retrieve the information about the supplied save game.

getSaveGameWidget(parent)

Retrieve a widget to display over the save game list.

hasScriptExtenderSave(filepath)

Check whether or not the save has a paired script extender save.

-

Methods Documentation

-
-
-abstract getMissingAssets(filepath)Ā¶
-

Retrieve missing assets from the save.

-
-
Parameters
-

filepath ā€“ Path to the save file.

-
-
Returns
-

A collection of missing assets and the modules that can supply those assets.

-
-
Return type
-

Dict[str, List[str]]

-
-
-
- -
-
-abstract getSaveGameInfo(filepath)Ā¶
-

Retrieve the information about the supplied save game.

-
-
Parameters
-

filepath ā€“ Path to the save file.

-
-
Returns
-

A SaveGame corresponding to the given save file.

-
-
Return type
-

ISaveGame

-
-
-
- -
-
-abstract getSaveGameWidget(parent)Ā¶
-

Retrieve a widget to display over the save game list.

-

This method is allowed to return None in case no widget has been implemented.

-
-
Parameters
-

parent ā€“ The parent widget.

-
-
Returns
-

A SaveGameInfoWidget to display information about save game.

-
-
Return type
-

Optional[ISaveGameInfoWidget]

-
-
-
- -
-
-abstract hasScriptExtenderSave(filepath)Ā¶
-

Check whether or not the save has a paired script extender save.

-
-
Parameters
-

filepath ā€“ Path to the save file.

-
-
Returns
-

True if the given save file has a paired script extender save, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.ScriptExtender.html b/gh-pages/api/mobase.ScriptExtender.html deleted file mode 100644 index 4b65859..0000000 --- a/gh-pages/api/mobase.ScriptExtender.html +++ /dev/null @@ -1,504 +0,0 @@ - - - - - - - - - - ScriptExtender — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ScriptExtenderĀ¶

-
-
-class mobase.ScriptExtenderĀ¶
-

Bases: abc.ABC

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

BinaryName()

-
returns
-

The name of the script extender binary.

-
-
-

PluginPath()

-
returns
-

The script extender plugin path, relative to the data folder.

-
-
-

getArch()

-
returns
-

The CPU platform of the extender.

-
-
-

getExtenderVersion()

-
returns
-

The version of the script extender.

-
-
-

isInstalled()

-
returns
-

True if the script extender is installed, False otherwise.

-
-
-

loaderName()

-
returns
-

The loader to use to ensure the game runs with the script extender.

-
-
-

loaderPath()

-
returns
-

The fullpath to the script extender loader.

-
-
-

saveGameAttachmentExtensions()

-
returns
-

Additional savegame attachments.

-
-
-

-

Methods Documentation

-
-
-abstract BinaryName()Ā¶
-
-
Returns
-

The name of the script extender binary.

-
-
Return type
-

str

-
-
-
- -
-
-abstract PluginPath()Ā¶
-
-
Returns
-

The script extender plugin path, relative to the data folder.

-
-
Return type
-

str

-
-
-
- -
-
-abstract getArch()Ā¶
-
-
Returns
-

The CPU platform of the extender.

-
-
Return type
-

int

-
-
-
- -
-
-abstract getExtenderVersion()Ā¶
-
-
Returns
-

The version of the script extender.

-
-
Return type
-

str

-
-
-
- -
-
-abstract isInstalled()Ā¶
-
-
Returns
-

True if the script extender is installed, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-abstract loaderName()Ā¶
-
-
Returns
-

The loader to use to ensure the game runs with the script extender.

-
-
Return type
-

str

-
-
-
- -
-
-abstract loaderPath()Ā¶
-
-
Returns
-

The fullpath to the script extender loader.

-
-
Return type
-

str

-
-
-
- -
-
-abstract saveGameAttachmentExtensions()Ā¶
-
-
Returns
-

Additional savegame attachments.

-
-
Return type
-

List[str]

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.SortMechanism.html b/gh-pages/api/mobase.SortMechanism.html deleted file mode 100644 index bef6129..0000000 --- a/gh-pages/api/mobase.SortMechanism.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - - - - - - - SortMechanism — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

SortMechanismĀ¶

-
-
-class mobase.SortMechanismĀ¶
-

Bases: enum.Enum

-

An enumeration.

-

Attributes Summary

- ---- - - - - - - - - - - - - - - -

BOSS

LOOT

MLOX

NONE

-

Attributes Documentation

-
-
-BOSS = EllipsisĀ¶
-
- -
-
-LOOT = EllipsisĀ¶
-
- -
-
-MLOX = EllipsisĀ¶
-
- -
-
-NONE = EllipsisĀ¶
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.UnmanagedMods.html b/gh-pages/api/mobase.UnmanagedMods.html deleted file mode 100644 index c5c39a7..0000000 --- a/gh-pages/api/mobase.UnmanagedMods.html +++ /dev/null @@ -1,420 +0,0 @@ - - - - - - - - - - UnmanagedMods — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

UnmanagedModsĀ¶

-
-
-class mobase.UnmanagedModsĀ¶
-

Bases: abc.ABC

-

Methods Summary

- ---- - - - - - - - - - - - - - - -

displayName(mod_name)

Retrieve the display name of a given mod.

mods(official_only)

Retrieve the list of unmanaged mods for the corresponding game.

referenceFile(mod_name)

Retrieve the reference file for the requested mod.

secondaryFiles(mod_name)

Retrieve the secondary files for the requested mod.

-

Methods Documentation

-
-
-abstract displayName(mod_name)Ā¶
-

Retrieve the display name of a given mod.

-
-
Parameters
-

mod_name ā€“ Internal name of the mod.

-
-
Returns
-

The display name of the mod.

-
-
Return type
-

str

-
-
-
- -
-
-abstract mods(official_only)Ā¶
-

Retrieve the list of unmanaged mods for the corresponding game.

-
-
Parameters
-

official_only ā€“ Retrieve only unmanaged official mods.

-
-
Returns
-

The list of unmanaged mods (internal names).

-
-
Return type
-

List[str]

-
-
-
- -
-
-abstract referenceFile(mod_name)Ā¶
-

Retrieve the reference file for the requested mod.

-

Example: For Bethesda games, the reference file may be the main -plugin (esp or esm) for the game or a DLCs.

-
-
Parameters
-

mod_name ā€“ Internal name of the mod.

-
-
Returns
-

The reference file (absolute path) for the requested mod.

-
-
Return type
-

QFileInfo

-
-
-
- -
-
-abstract secondaryFiles(mod_name)Ā¶
-

Retrieve the secondary files for the requested mod.

-

Example: For Bethesda games, the secondary files may be the archives -corresponding to the reference file.

-
-
Parameters
-

mod_name ā€“ Internal name of the mod.

-
-
Returns
-

The secondary files (absolute paths) for the request mod.

-
-
Return type
-

List[str]

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.VersionInfo.html b/gh-pages/api/mobase.VersionInfo.html deleted file mode 100644 index 7c6253a..0000000 --- a/gh-pages/api/mobase.VersionInfo.html +++ /dev/null @@ -1,452 +0,0 @@ - - - - - - - - - - VersionInfo — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

VersionInfoĀ¶

-
-
-class mobase.VersionInfo(**kwds)Ā¶
-

Bases: object

-

Represents the version of a mod or plugin.

-

Methods Summary

- ---- - - - - - - - - - - - - - - - - - - - - -

canonicalString()

-
returns
-

A canonical string representing this version, that can be stored and then parsed using the parse() method.

-
-
-

clear()

Resets this VersionInfo to an invalid version.

displayString([forced_segments])

-
param forced_segments
-

The number of version segments to display even if the version is 0. 1 is major, 2 is major and minor, etc. The only implemented ranges are (-inf,2] for major/minor, [3] for major/minor/subminor,

-
-
-

isValid()

-
returns
-

True if this VersionInfo is valid, False otherwise.

-
-
-

parse(value[,Ā scheme,Ā manual_input])

Update this VersionInfo by parsing the given string using the given scheme.

scheme()

-
returns
-

The version scheme in effect for this VersionInfo.

-
-
-

-

Methods Documentation

-
-
-canonicalString()Ā¶
-
-
Returns
-

A canonical string representing this version, that can be stored and then parsed using the parse() method.

-
-
Return type
-

str

-
-
-
- -
-
-clear()Ā¶
-

Resets this VersionInfo to an invalid version.

-
- -
-
-displayString(forced_segments=2)Ā¶
-
-
Parameters
-

forced_segments ā€“ The number of version segments to display even if the version is 0. 1 is major, 2 is major and minor, etc. The only implemented ranges are (-inf,2] for major/minor, [3] for major/minor/subminor, -and [4,inf) for major/minor/subminor/subsubminor. This only versions with a regular scheme.

-
-
Returns
-

A string for display to the user. The returned string may not contain enough information to reconstruct this version info.

-
-
Return type
-

str

-
-
-
- -
-
-isValid()Ā¶
-
-
Returns
-

True if this VersionInfo is valid, False otherwise.

-
-
Return type
-

bool

-
-
-
- -
-
-parse(value, scheme=<VersionScheme.DISCOVER: Ellipsis>, manual_input=False)Ā¶
-

Update this VersionInfo by parsing the given string using the given scheme.

-
-
Parameters
-
    -

  • value ā€“ String to parse.

    • -

  • scheme ā€“ Scheme to use to parse the string.

    • -

  • manual_input ā€“ True if the given string should be treated as user input.

    • -
-
-
-
- -
-
-scheme()Ā¶
-
-
Returns
-

The version scheme in effect for this VersionInfo.

-
-
Return type
-

VersionScheme

-
-
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.VersionScheme.html b/gh-pages/api/mobase.VersionScheme.html deleted file mode 100644 index b6a90a8..0000000 --- a/gh-pages/api/mobase.VersionScheme.html +++ /dev/null @@ -1,382 +0,0 @@ - - - - - - - - - - VersionScheme — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

VersionSchemeĀ¶

-
-
-class mobase.VersionSchemeĀ¶
-

Bases: enum.Enum

-

An enumeration.

-

Attributes Summary

- ---- - - - - - - - - - - - - - - - - - - - - -

DATE

DECIMAL_MARK

DISCOVER

LITERAL

NUMBERS_AND_LETTERS

REGULAR

-

Attributes Documentation

-
-
-DATE = EllipsisĀ¶
-
- -
-
-DECIMAL_MARK = EllipsisĀ¶
-
- -
-
-DISCOVER = EllipsisĀ¶
-
- -
-
-LITERAL = EllipsisĀ¶
-
- -
-
-NUMBERS_AND_LETTERS = EllipsisĀ¶
-
- -
-
-REGULAR = EllipsisĀ¶
-
- -
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.getFileVersion.html b/gh-pages/api/mobase.getFileVersion.html deleted file mode 100644 index ade4269..0000000 --- a/gh-pages/api/mobase.getFileVersion.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - - - - - getFileVersion — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

getFileVersionĀ¶

-
-
-mobase.getFileVersion(filepath)Ā¶
-

Retrieve the file version of the given executable.

-
-
Parameters
-

filepath ā€“ Absolute path to the executable.

-
-
Returns
-

The file version, or an empty string if the file version could not be retrieved.

-
-
Return type
-

str

-
-
-
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.getIconForExecutable.html b/gh-pages/api/mobase.getIconForExecutable.html deleted file mode 100644 index b7084d2..0000000 --- a/gh-pages/api/mobase.getIconForExecutable.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - - - - - getIconForExecutable — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

getIconForExecutableĀ¶

-
-
-mobase.getIconForExecutable(executable)Ā¶
-

Retrieve the icon of an executable. Currently this always extracts the biggest icon.

-
-
Parameters
-

executable ā€“ Absolute path to the executable.

-
-
Returns
-

The icon for this executable, if any.

-
-
Return type
-

QIcon

-
-
-
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/api/mobase.getProductVersion.html b/gh-pages/api/mobase.getProductVersion.html deleted file mode 100644 index e3ddd1d..0000000 --- a/gh-pages/api/mobase.getProductVersion.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - - - - - getProductVersion — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

getProductVersionĀ¶

-
-
-mobase.getProductVersion(executable)Ā¶
-

Retrieve the product version of the given executable.

-
-
Parameters
-

executable ā€“ Absolute path to the executable.

-
-
Returns
-

The product version, or an empty string if the product version could not be retrieved.

-
-
Return type
-

str

-
-
-
- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/faq.html b/gh-pages/faq.html deleted file mode 100644 index dea7f58..0000000 --- a/gh-pages/faq.html +++ /dev/null @@ -1,362 +0,0 @@ - - - - - - - - - - FAQ — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

FAQĀ¶

-
-
-
-

1. Why is MO2 throwing an exception when I try to create a type inheriting one of MO2 class?Ā¶

-

This often happens if you forget to call super().__init__() with the right arguments. -Even if the list of arguments is empty (as in the example), it must be called due to a ā€œbugā€ -in boost::python:

-
class MySaveGame(mobase.ISaveGame):
-    def __init__(self):
-        super().__init__()  # Mandatory!
-
-
-
-
-

2. How can I be sure to implement all the required methods when creating a plugin?Ā¶

-

It is kind of annoying to create a MO2 python plugin that kind of works and have it crash -at some point simply because there plugin is missing a function implementation. -You can have mypy warn you for such issue by typing the createPlugin or createPlugins -functions:

-
import typing
-
-# A plugin that is missing something (e.g. display()).
-class MyPlugin(mobase.IPluginTool): ...
-
-# If you type-hint `createPlugin` by adding `-> mobase.IPlugin`,
-# `mypy` will warn you that `MyPlugin` is an incomplete class.
-def createPlugin() -> mobase.IPlugin:
-    return MyPlugin()
-
-# You can also type-hint `createPlugins`:
-def createPlugins() -> typing.List[mobase.IPlugin]:
-    return [MyPlugin()]
-
-
-
-
-

3. Why are my isinstance(x, QObject) and isinstance(y, QWidget) not working?Ā¶

-

Some classes from mobase are said to inherit QObject and QWidget in the -stubs, such as mobase.IDownloadManager. -This is not the case in practice due to limitation in Python and boost::python. -The bases are in the stubs to allow for auto-completion and typing, which is then -simulated in the real mobase by overriding __getattr__ and delegating to -the underlying QObject or QWidget.

-
-
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/genindex.html b/gh-pages/genindex.html deleted file mode 100644 index 6787de6..0000000 --- a/gh-pages/genindex.html +++ /dev/null @@ -1,1330 +0,0 @@ - - - - - - - - - - - Index — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Index
    • - - -
  • - - - -
    • - -
- - -
-
-
-
- - -

Index

- -
- A - | B - | C - | D - | E - | F - | G - | H - | I - | K - | L - | M - | N - | O - | P - | R - | S - | T - | U - | V - | W - -
-

A

- - - -
- -

B

- - - -
- -

C

- - - -
- -

D

- - - -
- -

E

- - - -
- -

F

- - - -
- -

G

- - - -
- -

H

- - - -
- -

I

- - - -
- -

K

- - -
- -

L

- - - -
- -

M

- - - -
- -

N

- - - -
- -

O

- - - -
- -

P

- - - -
- -

R

- - - -
- -

S

- - - -
- -

T

- - - -
- -

U

- - - -
- -

V

- - - -
- -

W

- - - -
- - - -
- -
-
- - -
- -
-

- - © Copyright 2020, Holt59 - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/index.html b/gh-pages/index.html deleted file mode 100644 index d8792d5..0000000 --- a/gh-pages/index.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - - - - - Welcome to MO2 Python Plugin APIā€™s documentation! — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Welcome to MO2 Python Plugin APIā€™s documentation!
    • - - -
  • - - - View page source - - -
    • - -
- - -
-
-
-
- -
-

Welcome to MO2 Python Plugin APIā€™s documentation!Ā¶

-

Plugins are a way to extend Mod Organizers functionality. You can write plugins in either C++ or Python, -theoretically with either being as powerful as the other. -This documentation is dedicated to writting MO2 Python plugins.

-
-

Contents:

- -
-
- - -
- -
-
- - - - -
- -
-

- - © Copyright 2020, Holt59 - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/mobase.html b/gh-pages/mobase.html deleted file mode 100644 index 53971c3..0000000 --- a/gh-pages/mobase.html +++ /dev/null @@ -1,507 +0,0 @@ - - - - - - - - - - mobase API — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

mobase APIĀ¶

-
-

FunctionsĀ¶

- ---- - - - - - - - - - - - - - - -

getFileVersion(filepath)

Retrieve the file version of the given executable.

getIconForExecutable(executable)

Retrieve the icon of an executable.

getProductVersion(executable)

Retrieve the product version of the given executable.

overload(func)

Decorator for overloaded functions/methods.

-
-
-

ClassesĀ¶

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

BSAInvalidation()

DataArchives()

Enum

Generic enumeration.

ExecutableForcedLoadSetting(process,Ā library)

ExecutableInfo(title,Ā binary)

FileInfo()

Information about a virtualised file

FileTreeEntry

Represent an entry in a file tree, either a file or a directory.

GamePlugins()

GuessQuality

Describes how good the code considers a guess (i.e.

GuessedString(**kwds)

Represents a string that may be set from different places.

IDownloadManager

IFileTree

Interface to classes that provides way to visualize and alter file trees.

IInstallationManager

IModInterface

IModList

Interface to the mod-list.

IModRepositoryBridge

IOrganizer

Interface to class that provides information about the running session of Mod Organizer to be used by plugins.

IPlugin()

Base class for all plugins.

IPluginDiagnose()

Plugins that create problem reports to be displayed in the UI.

IPluginFileMapper()

Plugins that adds virtual file links.

IPluginGame()

Base classes for game plugins.

IPluginInstaller()

This is the top-level class for installer.

IPluginInstallerCustom()

Custom installer for mods.

IPluginInstallerSimple()

Simple installer for mods.

IPluginList

Primary interface to the list of plugins.

IPluginModPage()

IPluginPreview()

These plugins add support for previewing files in the data pane.

IPluginTool()

This is the simplest of plugin interfaces.

IProfile

ISaveGame()

Base class for information about what is in a save game.

ISaveGameInfoWidget([parent])

Base class for a save game info widget.

InstallResult

An enumeration.

InterfaceNotImplemented

LoadOrderMechanism

An enumeration.

LocalSavegames()

Mapping()

ModDataChecker()

Game feature that is used to check the content of a data tree.

ModDataContent()

The ModDataContent feature is used (when available) to indicate to users the content of mods in the ā€œContentā€ column.

ModRepositoryFileInfo(**kwds)

ModState

An enumeration.

PluginSetting(key,Ā description,Ā default_value)

Class to hold the user-configurable parameters a plugin accepts.

PluginState

An enumeration.

ProfileSetting

An enumeration.

ReleaseType

An enumeration.

SaveGameInfo()

Feature to get hold of stuff to do with save games.

ScriptExtender()

SortMechanism

An enumeration.

TypeVar(name,Ā *constraints[,Ā bound,Ā ā€¦])

Type variable.

UnmanagedMods()

VersionInfo(**kwds)

Represents the version of a mod or plugin.

VersionScheme

An enumeration.

-
-
-
-
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/modules.html b/gh-pages/modules.html deleted file mode 100644 index 541083c..0000000 --- a/gh-pages/modules.html +++ /dev/null @@ -1,372 +0,0 @@ - - - - - - - - - - mobase — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- - - - -
- -
-
- - -
- -
-

- - © Copyright 2020, Holt59 - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/objects.inv b/gh-pages/objects.inv deleted file mode 100644 index ae105b3..0000000 Binary files a/gh-pages/objects.inv and /dev/null differ diff --git a/gh-pages/plugin-types.html b/gh-pages/plugin-types.html deleted file mode 100644 index 7380bf9..0000000 --- a/gh-pages/plugin-types.html +++ /dev/null @@ -1,458 +0,0 @@ - - - - - - - - - - Type of Plugins — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

Type of PluginsĀ¶

-

Plugins are passive, that is: they react to events emitted by the core application or extend -an existing functionality (like adding support for additional types of installers). Plugins -should integrate with Mod Organizers concepts. While you could write an INI editor that works with -the global INI files instead of the profile specific ones, what would be the point?

-

Depending on where/how the plugin integrates with MO you need to write a different type of plugin, -in practice this means you need to implement a different interface (inherit from a different base -plugin class from mobase). As mentioned above, plugins are passive: the plugin type decides how/when -MO makes requests to/invokes your plugin. -All plugins however gain access to MOs own plugin interface so all plugins get to make the same requests -to MO.

-
-

InstallersĀ¶

-
-
Interface: IPluginInstaller, IPluginInstallerSimple, -IPluginInstallerCustom
-
Examples: installer_bain, installer_bundle, installer_fomod, installer_ncc, installer_quick, installer_manual.
-
-

An installer is invoked when the user tries to install a mod, either by double clicking in the download -view or through the ā€œInstall Mod..ā€ button or ā€œReinstall modā€ item from the mod lists context menu. -There are actually two ways to write an installer, simple or complex:

-
    -

  • With simple installers, MO does the unpacking of the file but this works only with standard archive formats. -The plugin can then select the files and folders that requires extraction, and where to extract them.

    • -

  • Complex installers are more flexible but require a bit more work.

    • -
-
-
-

PreviewersĀ¶

-
-
Interfaces: IPluginPreview
-
Examples: preview_base
-
-

These plugins add support for previewing files in the data pane. -Right now all image formats supported by Qt are implemented (including .dds) but no audio files and -no 3d mesh formats.

-
-
-

Mod PageĀ¶

-

WIP

-
-
Interfaces: IPluginModPage
-
Examples: page_tesalliance
-
-

Mod Page plugins implement interfaces to modding communities where mods can be downloaded, checked -for updates and so on. -This interface is not finished and some of the bits that are do not actually get used. The goal is -that the whole Nexus integration can be implemented through this interface and can then be removed -from the core application. This is a task for the distant future, unless someone wants to volunteer.

-
-
-

GameĀ¶

-
-
Interfaces: IPluginGame
-
Examples: game_oblivion, game_fallout3, game_falloutnv, game_skyrim, ā€¦
-
-

These plugins (shall eventually) implement all the game specific features and further game plugins are -able to add support for further games. -The plugin is also responsible to help MO determine if (and where) the game is installed in the first place. -Since supporting a game properly requires extensions in many places of the UI. -To allow this without creating one huge plugin interface that involves every aspect of MO, game plugins -expose a feature list. -The list of possible features can be found in the ā€œgame_featuresā€ project and each feature can itself be -considered a plugin interface.

-

As an example for a game feature take BSA invalidation: If the game requires BSA invalidation it will implement -this feature. -Wherever the core can support BSA invalidation it will query whether the current game has this feature and if so -query the implementation on specifics (like ā€œHow should the invalidation BSA be calledā€ and ā€œwhatā€™s the right bsa versionā€). -Of course, the goal is for feature interfaces to be as generic as possible without limiting usefulness.

-

Note: The IPluginGame interface is complex, and mostly designed for Gamebryo games. If you plan -on writting a game plugin for another type of games, you might be interested by a simpler interface and might -want to check out the Basic Games meta-plugin.

-
-
-

ToolĀ¶

-
-
Interfaces: IPluginTool
-
Examples: tool_configurator, tool_inieditor, fnistool
-
-

This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools submenu and get -invoked when the user clicks it. They are expected to have a user interface of some sort. -These are almost like independent applications except they can access all Mod Organizer interfaces like querying -and modifying the current profile, mod list, load order, use MO to install mods and so on. -A tool plugin can (and should!) integrate its UI as a window inside MO and thus doesnā€™t have to initialize a -windows application itself.

-
-
-

ProxiesĀ¶

-
-
Interfaces: IPluginProxy
-
Examples: plugin_python
-
-

Proxy Plugins expose the plugin api to foreign languages. This is what allows you to write plugins using python -in the first place. -The python proxy is easily the most complicated plugin and requires constant updating so if youā€™re considering -writing a Haskell plugin because that is your programming language of choice, I am fairly certain learning python -is easier than writing the haskell proxy. Just saying. -And no, you can not write a proxy for a third language in Python, do not be silly.

-
-
-

Free PluginsĀ¶

-
-
Interfaces: IPlugin
-
Examples: check_fnis, bsa_extractor, diagnose_basic, tool_inibakery
-
-

ā€œFreeā€ plugins implement none of the interfaces and thus initially do not integrate with MO at all. -They are initialized by MO and get access to the MO interface. -This makes sense if you only want to implement one of the extension interfaces (see below) or register handlers -for events.

-
-
-

Extension InterfacesĀ¶

-

In Python, these interfaces are similar to other plugin types, but in C++, those do not inherit IPlugin so -that plugins can implement one or more of these interfaces, in addition to a normal plugin type.

-
-

DiagnoseĀ¶

-
-
Interfaces: IPluginDiagnose
-
Examples: diagnose_basic, installer_ncc, plugin_python, script_extender_plugin_checker
-
-

This interface lets the plugin report issues that are then listed in the ā€œProblemsā€ icon in the main window. -If possible the plugin can also provide an automatic or guided fix to the problem. -The diagnose_basic plugin does nothing but analyze the MO installation and report problems it discovers (like -ā€œThere are files in your overwrite directory.ā€) but usually a plugin will want to report issues relevant for its -own operation. -For instance, installer_ncc requires a specific version of .NET and will report a problem if it is not installed. -This should always be the prefered way to communicate problems the user has to fix but should never be used for problems -he cannot fix (i.e. ā€œThis plugin does not work with this game.ā€). -An empty problem list should always be achievable.

-
-
-

File MappingsĀ¶

-
-
Interfaces: IPluginFileMapper
-
Examples: tool_inibakery, game_gamebryo
-
-

This interface allows plugins to add virtual file (or directory) links to the virtual file system in addition to the -mod files. -Profile-local save games, ini-files and load-orders are all implemented this way in MO2.

-
-
-
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/py-modindex.html b/gh-pages/py-modindex.html deleted file mode 100644 index e47de5d..0000000 --- a/gh-pages/py-modindex.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - - - - Python Module Index — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Python Module Index
    • - - -
  • - -
    • - -
- - -
-
-
-
- - -

Python Module Index

- -
- m -
- - - - - - - -
 
- m
- mobase -
- - -
- -
-
- - -
- -
-

- - © Copyright 2020, Holt59 - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
- -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/search.html b/gh-pages/search.html deleted file mode 100644 index 02294b3..0000000 --- a/gh-pages/search.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - - - - - Search — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- -
    - -
  • »
    • - -
  • Search
    • - - -
  • - - - -
    • - -
- - -
-
-
-
- - - - -
- -
- -
- -
-
- - -
- -
-

- - © Copyright 2020, Holt59 - -

-
- - - - Built with Sphinx using a - - theme - - provided by Read the Docs. - -
- -
-
- -
- -
- - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/searchindex.js b/gh-pages/searchindex.js deleted file mode 100644 index 015f4fc..0000000 --- a/gh-pages/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({docnames:["api/mobase.BSAInvalidation","api/mobase.DataArchives","api/mobase.ExecutableForcedLoadSetting","api/mobase.ExecutableInfo","api/mobase.FileInfo","api/mobase.FileTreeEntry","api/mobase.GamePlugins","api/mobase.GuessQuality","api/mobase.GuessedString","api/mobase.IDownloadManager","api/mobase.IFileTree","api/mobase.IInstallationManager","api/mobase.IModInterface","api/mobase.IModList","api/mobase.IModRepositoryBridge","api/mobase.IOrganizer","api/mobase.IPlugin","api/mobase.IPluginDiagnose","api/mobase.IPluginFileMapper","api/mobase.IPluginGame","api/mobase.IPluginInstaller","api/mobase.IPluginInstallerCustom","api/mobase.IPluginInstallerSimple","api/mobase.IPluginList","api/mobase.IPluginModPage","api/mobase.IPluginPreview","api/mobase.IPluginTool","api/mobase.IProfile","api/mobase.ISaveGame","api/mobase.ISaveGameInfoWidget","api/mobase.InstallResult","api/mobase.InterfaceNotImplemented","api/mobase.LoadOrderMechanism","api/mobase.LocalSavegames","api/mobase.Mapping","api/mobase.ModDataChecker","api/mobase.ModDataContent","api/mobase.ModRepositoryFileInfo","api/mobase.ModState","api/mobase.PluginSetting","api/mobase.PluginState","api/mobase.ProfileSetting","api/mobase.ReleaseType","api/mobase.SaveGameInfo","api/mobase.ScriptExtender","api/mobase.SortMechanism","api/mobase.UnmanagedMods","api/mobase.VersionInfo","api/mobase.VersionScheme","api/mobase.getFileVersion","api/mobase.getIconForExecutable","api/mobase.getProductVersion","faq","index","mobase","modules","plugin-types","setup-tools","writing-plugins"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.index":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:56},filenames:["api/mobase.BSAInvalidation.rst","api/mobase.DataArchives.rst","api/mobase.ExecutableForcedLoadSetting.rst","api/mobase.ExecutableInfo.rst","api/mobase.FileInfo.rst","api/mobase.FileTreeEntry.rst","api/mobase.GamePlugins.rst","api/mobase.GuessQuality.rst","api/mobase.GuessedString.rst","api/mobase.IDownloadManager.rst","api/mobase.IFileTree.rst","api/mobase.IInstallationManager.rst","api/mobase.IModInterface.rst","api/mobase.IModList.rst","api/mobase.IModRepositoryBridge.rst","api/mobase.IOrganizer.rst","api/mobase.IPlugin.rst","api/mobase.IPluginDiagnose.rst","api/mobase.IPluginFileMapper.rst","api/mobase.IPluginGame.rst","api/mobase.IPluginInstaller.rst","api/mobase.IPluginInstallerCustom.rst","api/mobase.IPluginInstallerSimple.rst","api/mobase.IPluginList.rst","api/mobase.IPluginModPage.rst","api/mobase.IPluginPreview.rst","api/mobase.IPluginTool.rst","api/mobase.IProfile.rst","api/mobase.ISaveGame.rst","api/mobase.ISaveGameInfoWidget.rst","api/mobase.InstallResult.rst","api/mobase.InterfaceNotImplemented.rst","api/mobase.LoadOrderMechanism.rst","api/mobase.LocalSavegames.rst","api/mobase.Mapping.rst","api/mobase.ModDataChecker.rst","api/mobase.ModDataContent.rst","api/mobase.ModRepositoryFileInfo.rst","api/mobase.ModState.rst","api/mobase.PluginSetting.rst","api/mobase.PluginState.rst","api/mobase.ProfileSetting.rst","api/mobase.ReleaseType.rst","api/mobase.SaveGameInfo.rst","api/mobase.ScriptExtender.rst","api/mobase.SortMechanism.rst","api/mobase.UnmanagedMods.rst","api/mobase.VersionInfo.rst","api/mobase.VersionScheme.rst","api/mobase.getFileVersion.rst","api/mobase.getIconForExecutable.rst","api/mobase.getProductVersion.rst","faq.rst","index.rst","mobase.rst","modules.rst","plugin-types.rst","setup-tools.rst","writing-plugins.rst"],objects:{"":{mobase:[54,0,0,"-"]},"mobase.BSAInvalidation":{activate:[0,2,1,""],deactivate:[0,2,1,""],isInvalidationBSA:[0,2,1,""]},"mobase.DataArchives":{addArchive:[1,2,1,""],archives:[1,2,1,""],removeArchive:[1,2,1,""],vanillaArchives:[1,2,1,""]},"mobase.ExecutableForcedLoadSetting":{enabled:[2,2,1,""],forced:[2,2,1,""],library:[2,2,1,""],process:[2,2,1,""],withEnabled:[2,2,1,""],withForced:[2,2,1,""]},"mobase.ExecutableInfo":{arguments:[3,2,1,""],asCustom:[3,2,1,""],binary:[3,2,1,""],isCustom:[3,2,1,""],isValid:[3,2,1,""],steamAppID:[3,2,1,""],title:[3,2,1,""],withArgument:[3,2,1,""],withSteamAppId:[3,2,1,""],withWorkingDirectory:[3,2,1,""],workingDirectory:[3,2,1,""]},"mobase.FileInfo":{archive:[4,3,1,""],filePath:[4,3,1,""],origins:[4,3,1,""]},"mobase.FileTreeEntry":{DIRECTORY:[5,3,1,""],FILE:[5,3,1,""],FILE_OR_DIRECTORY:[5,3,1,""],detach:[5,2,1,""],fileType:[5,2,1,""],hasSuffix:[5,2,1,""],isDir:[5,2,1,""],isFile:[5,2,1,""],moveTo:[5,2,1,""],name:[5,2,1,""],parent:[5,2,1,""],path:[5,2,1,""],pathFrom:[5,2,1,""],suffix:[5,2,1,""]},"mobase.GamePlugins":{getLoadOrder:[6,2,1,""],lightPluginsAreSupported:[6,2,1,""],readPluginLists:[6,2,1,""],writePluginLists:[6,2,1,""]},"mobase.GuessQuality":{FALLBACK:[7,3,1,""],GOOD:[7,3,1,""],INVALID:[7,3,1,""],META:[7,3,1,""],PRESET:[7,3,1,""],USER:[7,3,1,""]},"mobase.GuessedString":{reset:[8,2,1,""],setFilter:[8,2,1,""],update:[8,2,1,""],variants:[8,2,1,""]},"mobase.IDownloadManager":{downloadComplete:[9,3,1,""],downloadFailed:[9,3,1,""],downloadPath:[9,2,1,""],downloadPaused:[9,3,1,""],downloadRemoved:[9,3,1,""],startDownloadNexusFile:[9,2,1,""],startDownloadURLs:[9,2,1,""]},"mobase.IFileTree":{CONTINUE:[10,3,1,""],FAIL_IF_EXISTS:[10,3,1,""],MERGE:[10,3,1,""],REPLACE:[10,3,1,""],SKIP:[10,3,1,""],STOP:[10,3,1,""],addDirectory:[10,2,1,""],addFile:[10,2,1,""],clear:[10,2,1,""],copy:[10,2,1,""],createOrphanTree:[10,2,1,""],exists:[10,2,1,""],find:[10,2,1,""],insert:[10,2,1,""],merge:[10,2,1,""],move:[10,2,1,""],pathTo:[10,2,1,""],remove:[10,2,1,""],removeAll:[10,2,1,""],removeIf:[10,2,1,""],walk:[10,2,1,""]},"mobase.IInstallationManager":{createFile:[11,2,1,""],extractFile:[11,2,1,""],extractFiles:[11,2,1,""],getSupportedExtensions:[11,2,1,""],installArchive:[11,2,1,""],setURL:[11,2,1,""]},"mobase.IModInterface":{absolutePath:[12,2,1,""],addCategory:[12,2,1,""],addNexusCategory:[12,2,1,""],categories:[12,2,1,""],name:[12,2,1,""],remove:[12,2,1,""],removeCategory:[12,2,1,""],setGameName:[12,2,1,""],setIsEndorsed:[12,2,1,""],setName:[12,2,1,""],setNewestVersion:[12,2,1,""],setNexusID:[12,2,1,""],setVersion:[12,2,1,""]},"mobase.IModList":{allMods:[13,2,1,""],displayName:[13,2,1,""],onModMoved:[13,2,1,""],onModStateChanged:[13,2,1,""],priority:[13,2,1,""],setActive:[13,2,1,""],setPriority:[13,2,1,""],state:[13,2,1,""]},"mobase.IModRepositoryBridge":{descriptionAvailable:[14,3,1,""],downloadURLsAvailable:[14,3,1,""],endorsementToggled:[14,3,1,""],endorsementsAvailable:[14,3,1,""],fileInfoAvailable:[14,3,1,""],filesAvailable:[14,3,1,""],requestDescription:[14,2,1,""],requestDownloadURL:[14,2,1,""],requestFailed:[14,3,1,""],requestFileInfo:[14,2,1,""],requestFiles:[14,2,1,""],requestToggleEndorsement:[14,2,1,""],trackedModsAvailable:[14,3,1,""],trackingToggled:[14,3,1,""]},"mobase.IOrganizer":{appVersion:[15,2,1,""],basePath:[15,2,1,""],createMod:[15,2,1,""],createNexusBridge:[15,2,1,""],downloadManager:[15,2,1,""],downloadsPath:[15,2,1,""],findFileInfos:[15,2,1,""],findFiles:[15,2,1,""],getFileOrigins:[15,2,1,""],getGame:[15,2,1,""],getMod:[15,2,1,""],installMod:[15,2,1,""],listDirectories:[15,2,1,""],managedGame:[15,2,1,""],modDataChanged:[15,2,1,""],modList:[15,2,1,""],modsPath:[15,2,1,""],modsSortedByProfilePriority:[15,2,1,""],onAboutToRun:[15,2,1,""],onFinishedRun:[15,2,1,""],onModInstalled:[15,2,1,""],onPluginSettingChanged:[15,2,1,""],onProfileChanged:[15,2,1,""],onUserInterfaceInitialized:[15,2,1,""],overwritePath:[15,2,1,""],persistent:[15,2,1,""],pluginDataPath:[15,2,1,""],pluginList:[15,2,1,""],pluginSetting:[15,2,1,""],profile:[15,2,1,""],profileName:[15,2,1,""],profilePath:[15,2,1,""],refreshModList:[15,2,1,""],removeMod:[15,2,1,""],resolvePath:[15,2,1,""],setPersistent:[15,2,1,""],setPluginSetting:[15,2,1,""],startApplication:[15,2,1,""],waitForApplication:[15,2,1,""]},"mobase.IPlugin":{author:[16,2,1,""],description:[16,2,1,""],init:[16,2,1,""],isActive:[16,2,1,""],name:[16,2,1,""],settings:[16,2,1,""],version:[16,2,1,""]},"mobase.IPluginDiagnose":{activeProblems:[17,2,1,""],fullDescription:[17,2,1,""],hasGuidedFix:[17,2,1,""],shortDescription:[17,2,1,""],startGuidedFix:[17,2,1,""]},"mobase.IPluginFileMapper":{mappings:[18,2,1,""]},"mobase.IPluginGame":{CCPlugins:[19,2,1,""],DLCPlugins:[19,2,1,""],binaryName:[19,2,1,""],dataDirectory:[19,2,1,""],documentsDirectory:[19,2,1,""],executableForcedLoads:[19,2,1,""],executables:[19,2,1,""],feature:[19,2,1,""],featureList:[19,2,1,""],gameDirectory:[19,2,1,""],gameIcon:[19,2,1,""],gameName:[19,2,1,""],gameNexusName:[19,2,1,""],gameShortName:[19,2,1,""],gameVariants:[19,2,1,""],gameVersion:[19,2,1,""],getLauncherName:[19,2,1,""],iniFiles:[19,2,1,""],initializeProfile:[19,2,1,""],isInstalled:[19,2,1,""],loadOrderMechanism:[19,2,1,""],looksValid:[19,2,1,""],nexusGameID:[19,2,1,""],nexusModOrganizerID:[19,2,1,""],primaryPlugins:[19,2,1,""],primarySources:[19,2,1,""],savegameExtension:[19,2,1,""],savegameSEExtension:[19,2,1,""],savesDirectory:[19,2,1,""],setGamePath:[19,2,1,""],setGameVariant:[19,2,1,""],sortMechanism:[19,2,1,""],steamAPPId:[19,2,1,""],validShortNames:[19,2,1,""]},"mobase.IPluginInstaller":{isArchiveSupported:[20,2,1,""],isManualInstaller:[20,2,1,""],priority:[20,2,1,""],setInstallationManager:[20,2,1,""],setParentWidget:[20,2,1,""]},"mobase.IPluginInstallerCustom":{install:[21,2,1,""],isArchiveSupported:[21,2,1,""],supportedExtensions:[21,2,1,""]},"mobase.IPluginInstallerSimple":{install:[22,2,1,""]},"mobase.IPluginList":{isMaster:[23,2,1,""],loadOrder:[23,2,1,""],masters:[23,2,1,""],onPluginMoved:[23,2,1,""],onRefreshed:[23,2,1,""],origin:[23,2,1,""],pluginNames:[23,2,1,""],priority:[23,2,1,""],setLoadOrder:[23,2,1,""],setState:[23,2,1,""],state:[23,2,1,""]},"mobase.IPluginModPage":{displayName:[24,2,1,""],handlesDownload:[24,2,1,""],icon:[24,2,1,""],pageURL:[24,2,1,""],setParentWidget:[24,2,1,""],useIntegratedBrowser:[24,2,1,""]},"mobase.IPluginPreview":{genFilePreview:[25,2,1,""],supportedExtensions:[25,2,1,""]},"mobase.IPluginTool":{display:[26,2,1,""],displayName:[26,2,1,""],icon:[26,2,1,""],setParentWidget:[26,2,1,""],tooltip:[26,2,1,""]},"mobase.IProfile":{absolutePath:[27,2,1,""],invalidationActive:[27,2,1,""],localSavesEnabled:[27,2,1,""],localSettingsEnabled:[27,2,1,""],name:[27,2,1,""]},"mobase.ISaveGame":{allFiles:[28,2,1,""],getCreationTime:[28,2,1,""],getFilename:[28,2,1,""],getSaveGroupIdentifier:[28,2,1,""],hasScriptExtenderFile:[28,2,1,""]},"mobase.ISaveGameInfoWidget":{setSave:[29,2,1,""]},"mobase.InstallResult":{CANCELED:[30,3,1,""],FAILED:[30,3,1,""],MANUAL_REQUESTED:[30,3,1,""],NOT_ATTEMPTED:[30,3,1,""],SUCCESS:[30,3,1,""]},"mobase.LoadOrderMechanism":{FILE_TIME:[32,3,1,""],PLUGINS_TXT:[32,3,1,""]},"mobase.LocalSavegames":{mappings:[33,2,1,""],prepareProfile:[33,2,1,""]},"mobase.Mapping":{createTarget:[34,3,1,""],destination:[34,3,1,""],isDirectory:[34,3,1,""],source:[34,3,1,""]},"mobase.ModDataChecker":{FIXABLE:[35,3,1,""],INVALID:[35,3,1,""],VALID:[35,3,1,""],dataLooksValid:[35,2,1,""],fix:[35,2,1,""]},"mobase.ModDataContent":{getAllContents:[36,2,1,""],getContentsFor:[36,2,1,""]},"mobase.ModRepositoryFileInfo":{categoryID:[37,3,1,""],createFromJson:[37,2,1,""],description:[37,3,1,""],fileCategory:[37,3,1,""],fileID:[37,3,1,""],fileName:[37,3,1,""],fileSize:[37,3,1,""],fileTime:[37,3,1,""],gameName:[37,3,1,""],modID:[37,3,1,""],modName:[37,3,1,""],name:[37,3,1,""],newestVersion:[37,3,1,""],repository:[37,3,1,""],uri:[37,3,1,""],userData:[37,3,1,""],version:[37,3,1,""]},"mobase.ModState":{ACTIVE:[38,3,1,""],ALTERNATE:[38,3,1,""],EMPTY:[38,3,1,""],ENDORSED:[38,3,1,""],ESSENTIAL:[38,3,1,""],EXISTS:[38,3,1,""],VALID:[38,3,1,""]},"mobase.PluginSetting":{default_value:[39,3,1,""],description:[39,3,1,""],key:[39,3,1,""]},"mobase.PluginState":{ACTIVE:[40,3,1,""],INACTIVE:[40,3,1,""],MISSING:[40,3,1,""]},"mobase.ProfileSetting":{CONFIGURATION:[41,3,1,""],MODS:[41,3,1,""],PREFER_DEFAULTS:[41,3,1,""],SAVEGAMES:[41,3,1,""]},"mobase.ReleaseType":{ALPHA:[42,3,1,""],BETA:[42,3,1,""],CANDIDATE:[42,3,1,""],FINAL:[42,3,1,""],PRE_ALPHA:[42,3,1,""]},"mobase.SaveGameInfo":{getMissingAssets:[43,2,1,""],getSaveGameInfo:[43,2,1,""],getSaveGameWidget:[43,2,1,""],hasScriptExtenderSave:[43,2,1,""]},"mobase.ScriptExtender":{BinaryName:[44,2,1,""],PluginPath:[44,2,1,""],getArch:[44,2,1,""],getExtenderVersion:[44,2,1,""],isInstalled:[44,2,1,""],loaderName:[44,2,1,""],loaderPath:[44,2,1,""],saveGameAttachmentExtensions:[44,2,1,""]},"mobase.SortMechanism":{BOSS:[45,3,1,""],LOOT:[45,3,1,""],MLOX:[45,3,1,""],NONE:[45,3,1,""]},"mobase.UnmanagedMods":{displayName:[46,2,1,""],mods:[46,2,1,""],referenceFile:[46,2,1,""],secondaryFiles:[46,2,1,""]},"mobase.VersionInfo":{canonicalString:[47,2,1,""],clear:[47,2,1,""],displayString:[47,2,1,""],isValid:[47,2,1,""],parse:[47,2,1,""],scheme:[47,2,1,""]},"mobase.VersionScheme":{DATE:[48,3,1,""],DECIMAL_MARK:[48,3,1,""],DISCOVER:[48,3,1,""],LITERAL:[48,3,1,""],NUMBERS_AND_LETTERS:[48,3,1,""],REGULAR:[48,3,1,""]},mobase:{BSAInvalidation:[0,1,1,""],DataArchives:[1,1,1,""],ExecutableForcedLoadSetting:[2,1,1,""],ExecutableInfo:[3,1,1,""],FileInfo:[4,1,1,""],FileTreeEntry:[5,1,1,""],GamePlugins:[6,1,1,""],GuessQuality:[7,1,1,""],GuessedString:[8,1,1,""],IDownloadManager:[9,1,1,""],IFileTree:[10,1,1,""],IInstallationManager:[11,1,1,""],IModInterface:[12,1,1,""],IModList:[13,1,1,""],IModRepositoryBridge:[14,1,1,""],IOrganizer:[15,1,1,""],IPlugin:[16,1,1,""],IPluginDiagnose:[17,1,1,""],IPluginFileMapper:[18,1,1,""],IPluginGame:[19,1,1,""],IPluginInstaller:[20,1,1,""],IPluginInstallerCustom:[21,1,1,""],IPluginInstallerSimple:[22,1,1,""],IPluginList:[23,1,1,""],IPluginModPage:[24,1,1,""],IPluginPreview:[25,1,1,""],IPluginTool:[26,1,1,""],IProfile:[27,1,1,""],ISaveGame:[28,1,1,""],ISaveGameInfoWidget:[29,1,1,""],InstallResult:[30,1,1,""],InterfaceNotImplemented:[31,1,1,""],LoadOrderMechanism:[32,1,1,""],LocalSavegames:[33,1,1,""],Mapping:[34,1,1,""],ModDataChecker:[35,1,1,""],ModDataContent:[36,1,1,""],ModRepositoryFileInfo:[37,1,1,""],ModState:[38,1,1,""],PluginSetting:[39,1,1,""],PluginState:[40,1,1,""],ProfileSetting:[41,1,1,""],ReleaseType:[42,1,1,""],SaveGameInfo:[43,1,1,""],ScriptExtender:[44,1,1,""],SortMechanism:[45,1,1,""],UnmanagedMods:[46,1,1,""],VersionInfo:[47,1,1,""],VersionScheme:[48,1,1,""],getFileVersion:[49,4,1,""],getIconForExecutable:[50,4,1,""],getProductVersion:[51,4,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function"},terms:{"abstract":[0,1,6,16,17,18,19,20,21,22,24,25,26,29,33,35,36,43,44,46,58],"boolean":15,"case":[5,9,15,19,22,43,52],"class":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,53,55,56,57,58],"default":[10,12,15,19,26],"enum":[7,30,32,38,40,41,42,45,48],"final":[11,42,58],"function":[10,13,15,19,23,52,53,55,56,58],"import":[23,52,57,58],"int":[9,10,13,15,17,19,20,22,23,36,37,39,44,57,58],"long":10,"new":[8,10,11,12,13,15,22,23,57],"null":[10,35],"return":[0,1,2,3,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,33,35,36,37,43,44,46,47,49,50,51,52,57,58],"short":[12,15,17,19],"static":[16,37],"super":[52,57,58],"switch":9,"throw":[10,17,53],"true":[5,6,10,11,12,13,15,16,17,19,20,23,24,28,43,44,47,57,58],"try":[19,35,53],"while":[10,56],AND:15,And:[56,57,58],For:[13,15,19,28,46,56,58],IDs:[17,36],MOs:56,Not:24,Such:[26,56],The:[1,5,8,9,10,11,12,13,15,16,17,19,20,21,22,23,24,25,26,28,35,36,39,43,44,46,47,49,50,51,52,56,57,58],There:[15,56,57,58],These:[19,25,26,56],Use:1,VFS:18,With:56,__getattr__:52,__init__:[52,57,58],_featurelist:19,_manag:20,_organ:58,_parentwidget:[20,24,26],_tr:58,abc:[0,1,6,16,33,35,36,43,44,46],abl:[20,21,56],about:[4,15,28,43],abov:[56,57,58],absolut:[9,11,12,15,46,49,50,51,58],absolutepath:[12,27],accept:39,access:[10,15,20,24,26,56],accord:15,achiev:56,activ:[0,13,15,16,17,19,23,38,40,58],activeproblem:17,actual:[10,15,19,20,22,39,56,58],adapt:57,add:[1,18,25,56,57,58],addarch:1,addcategori:12,adddirectori:10,addfil:10,adding:[52,56],addit:[44,56],addnexuscategori:12,after:[5,10,11,13,57],against:15,all:[10,13,16,19,23,25,26,28,36,53,56,58],allfil:28,allmod:13,allow:[8,9,15,16,19,43,52,56,58],almost:[26,56],alon:17,alpha:42,alreadi:[10,15,19,36],also:[5,8,10,12,23,52,56,58],alter:10,altern:[8,9,19,38],altogeth:8,alwai:[9,10,15,22,28,50,56,58],ambigu:13,analyz:56,ani:[10,15,37,39,50,57],annoi:52,anoth:[7,15,56],api:[13,55,56],app:19,app_id:3,appli:8,applic:[15,26,39,56],appvers:15,arbitrari:15,archiv:[1,4,10,11,15,20,21,22,35,46,56],archive_nam:21,arg:15,argument:[3,13,15,52,58],ascustom:3,ask:57,aspect:[19,56],asset:[43,58],assign:12,associ:[11,28,36],assum:57,astre:5,attach:[10,44],attribut:[4,5,7,9,10,14,19,30,32,34,35,37,38,39,40,41,42,45,48],audio:[25,56],author:[16,58],auto:[19,52,57],autocomplet:57,automat:[11,15,19,56],avail:[11,19,36,57],avoid:35,bar:57,base:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,52,56,58],basepath:15,basic:[23,56],basic_gam:19,becaus:[13,52,56],been:[10,15,19,20,24,26,43],befor:[1,15,23],begin:1,being:[9,11,53],belong:[14,28],below:56,best:8,beta:42,bethesda:[19,46],between:[10,28,58],biggest:50,binari:[3,44],binarynam:[19,44],bind:22,bit:56,bool:[0,2,3,5,6,10,12,13,15,16,17,19,20,23,24,27,28,33,34,37,39,43,44,47,57,58],boost:[52,58],boss:45,both:10,browser:24,bsa:[36,56],bsa_extractor:56,bsainvalid:55,bug:[52,58],built:10,button:56,call:[5,8,10,11,13,15,17,19,21,23,26,35,52,56,58],callback:[10,13,15,23],can:[5,8,9,10,11,15,17,19,20,21,22,23,24,26,28,35,36,43,47,53,56,57,58],cancel:[15,30],candid:42,cannot:[10,11,15,56,57],canon:47,canonicalstr:47,care:15,categori:12,category_id:12,categoryid:37,caus:13,ccplugin:19,certain:56,chang:[8,10,12,13,15,16,21,22,58],charact:28,check:[10,16,17,19,20,23,24,35,43,56,57,58],check_fni:56,checkreturn:35,child:10,choic:[8,56],choos:15,chose:19,clean:11,clear:[10,47],click:[26,56,57],club:19,code:[7,15,58],collect:43,column:36,com:[9,19,57],come:57,commun:56,complet:[15,52,57],complex:[5,56],complic:56,concept:56,config:57,configur:[15,19,39,41],conflict:10,consid:[7,19,56],constant:[5,56],construct:[10,26],constructor:58,conta:58,contain:[5,9,10,11,12,13,14,15,19,22,24,28,47,57],content:[20,22,35,36,53,57,58],context:56,continu:10,conveni:5,convers:12,copi:[10,57],core:56,correct:[10,57],correctli:[5,10,16],correspond:[5,9,10,11,15,17,19,20,36,43,46,57],cost:15,could:[10,11,15,35,49,51,56,58],cours:[56,57],cpu:44,crash:52,creat:[5,10,11,12,15,17,19,21,22,53,56,57,58],createfil:11,createfromjson:37,createmod:[15,21],createnexusbridg:15,createorphantre:10,createplugin:[52,57,58],createtarget:34,creation:[19,28],ctrl:57,current:[9,11,13,15,19,23,26,50,56],custom:[11,15,20,21],cwd:15,cywdcxj:57,data:[14,15,19,21,22,23,25,35,37,44,56,57,58],dataarch:55,datadirectori:19,datalooksvalid:35,date:[15,48],dds:[25,56],deactiv:0,deal:22,decid:56,decimal_mark:48,decreas:13,dedic:[15,53],def:[15,52,57,58],default_valu:39,defin:58,deleg:52,delet:[10,12,57],depend:[22,56,58],deprec:58,deriv:11,descend:10,describ:7,descript:[14,16,17,37,39,58],descriptionavail:14,design:[19,56],destin:34,destroi:10,detach:[5,10],detail:58,detect:19,determin:[7,19,56],diagnose_bas:56,diagnosi:17,dialog:11,dict:[10,15,19,37,39,43],did:[15,22],differ:[8,10,15,19,22,23,56,57,58],directli:[10,15,19,20,24,26,57,58],directori:[3,5,10,11,12,15,19,56,57],disabl:[13,15,16,23,58],disambigu:[15,23],disappear:13,disc:[12,15],discord:57,discov:[19,47,48,56],disk:[10,11,36],displai:[13,15,17,19,23,24,26,29,43,46,47,52,58],displaynam:[13,24,26,46],displaystr:47,distant:56,distinct:[10,16],dlc:[19,46],dlcplugin:19,dll:57,document:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48],documentsdirectori:19,doe:[10,12,15,19,23,35,39,56,58],doesn:[8,26,56],doing:58,done:10,dot:5,doubl:56,dow:57,down:57,downgrad:19,download:[9,14,15,19,24,56,57],download_url:24,downloadcomplet:9,downloadfail:9,downloadmanag:15,downloadpath:9,downloadpaus:9,downloadremov:9,downloadspath:15,downloadurlsavail:14,due:[52,58],dure:[19,35],dynam:58,each:[8,10,19,36,56,58],easier:56,easili:[35,56],edit:[19,22],editor:[56,57],effect:47,either:[5,10,20,23,36,53,56],ellipsi:[5,7,9,10,14,30,32,35,38,40,41,42,45,47,48],emit:56,empti:[5,10,11,15,19,21,22,23,38,49,51,52,56],enabl:[2,13,15,16,23,57,58],end:[1,8,10,11],endors:[12,13,14,38],endorsementsavail:14,endorsementtoggl:14,enough:47,ensur:44,entri:[5,10,11,57],enumer:[30,32,38,40,41,42,45,48],environ:53,equival:10,error:[12,57,58],esm:[19,23,46],esp:[19,23,46],essenti:38,etc:[47,57],evalu:13,even:[10,19,22,47,52],event:56,eventu:56,everi:[8,56],everyth:[5,57],exact:35,exampl:[19,21,46,52,56,58],except:[11,26,53,56],execut:[15,19,49,50,51],executableforcedload:19,executableforcedloadset:[19,55],executableinfo:[19,55],exist:[9,10,12,15,23,38,56],exit:15,exitcod:15,expect:[15,26,56],expens:13,explicitli:58,expos:[36,56,58],extend:[19,28,43,44,53,56,58],extens:[5,11,19,21,23,25,53,57],extern:[20,21],extract:[11,21,22,50,56],extractfil:11,extrapath:57,facilit:36,fail:[10,11,13,15,23,30],fail_if_exist:10,failur:[15,22],fairli:[13,56],fallback:7,fals:[5,6,10,11,12,13,15,16,17,19,20,23,24,28,43,44,47,58],faq:53,featur:[19,35,36,43,56],feature_typ:19,featurelist:19,feel:57,fetch:58,file:[1,4,5,9,10,11,12,13,14,15,18,19,20,21,22,23,25,28,29,36,43,46,49,57],file_id:[9,14],file_or_directori:5,file_tim:32,filecategori:37,fileid:37,fileinfo:[15,24,55],fileinfoavail:14,filenam:[15,23,25,37],filepath:[4,15,43,49],files:37,filesavail:14,filesystem:15,filetim:37,filetre:[22,35,36],filetreeentri:[10,55],filetyp:[5,10],filter:[8,10,15],find:[10,13,15,19,35],findfil:15,findfileinfo:15,finish:[15,56],first:[10,13,15,19,21,23,56],fix:[17,35,56],fixabl:35,flag:[19,23],flake8:57,flake8en:57,flexibl:56,fnistool:56,focu:57,folder:[10,11,15,19,35,44,56,57,58],follow:[57,58],forc:[2,19],forced_seg:47,forcedcustomoverwrit:15,foreign:56,forget:[52,57],forgot:58,format:[25,56],found:[10,15,17,56],free:[53,57],friendli:58,from:[1,5,7,8,9,10,11,12,13,15,19,21,22,23,43,52,56,58],full:[5,17],fulldescript:17,fulli:15,fullpath:44,further:[17,56],futur:[16,19,56],gain:56,game:[1,9,12,14,15,19,21,23,28,29,35,36,43,44,46,53],game_fallout3:56,game_falloutnv:56,game_featur:56,game_gamebryo:56,game_nam:[14,21],game_oblivion:56,game_skyrim:56,gamebryo:[23,56],gamedirectori:19,gamefeaturetyp:19,gameicon:19,gamenam:[19,37],gamenexusnam:19,gameplugin:55,gameshortnam:19,gamevari:19,gamevers:19,gener:[25,56,57],genfilepreview:25,get:[19,26,43,53,56],getallcont:36,getarch:44,getcontentsfor:36,getcreationtim:28,getextendervers:44,getfilenam:28,getfileorigin:15,getfilevers:55,getgam:15,geticonforexecut:55,getlaunchernam:19,getloadord:6,getmissingasset:43,getmod:15,getproductvers:55,getsavegameinfo:43,getsavegamewidget:43,getsavegroupidentifi:28,getsupportedextens:11,github:[19,57],give:58,given:[1,5,9,10,11,13,15,17,19,20,21,22,23,35,36,43,46,47,49,51,58],global:[12,56,57],goal:[10,56],going:57,good:[7,15],goti:19,gracefulli:19,greet:58,group:28,guarante:[10,35],guess:[7,8],guessedstr:55,guessqual:55,gui:36,guid:[17,56,57],handl:[15,19,20,21,22,24],handler:[13,15,19,23,56],handlesdownload:24,happen:[12,52],has:[5,10,15,17,19,20,24,26,28,35,43,56,58],hasguidedfix:17,haskel:56,hasscriptextenderfil:28,hasscriptextendersav:43,hassuffix:5,have:[10,15,19,21,23,26,35,52,56,57,58],heavi:35,help:56,helper:[5,8,10,15,21],here:[16,57,58],higher:[13,23],highest:[20,23],highli:57,hint:[52,58],hold:[10,39,43],how:[7,8,19,53,56,58],howev:[10,56],http:[19,57],huge:56,icon:[19,24,26,36,50,56],ident:13,identifi:[9,13,15,19,28],idownloadmanag:[15,52,55],ids:19,ifiletre:[5,22,35,55],ignor:[8,15],ignorecustomoverwrit:15,iinstallationmanag:55,imag:[25,56],immedi:15,imodinterfac:[15,55],imodlist:[15,55],imodrepositorybridg:[15,55],implement:[10,17,19,20,24,25,26,36,43,47,53,56,58],impli:10,inact:[23,40],includ:[5,10,23,25,56],incomplet:[9,52],independ:[26,56],index:1,indexerror:17,indic:[10,12,15,24,35,36,58],inf:47,info:[29,47],inform:[4,5,14,15,28,39,43,47],inherit:[5,20,53,56],ini:[19,56,57],inifil:[19,36],init:[16,57,58],initi:[10,15,16,19,20,24,26,56,58],initializeprofil:19,input:[21,22,47],insert:[1,10],insertpolici:10,insid:[10,26,56],instal:[11,13,15,19,20,21,22,23,26,35,44,53,57,58],installarch:11,installer_bain:56,installer_bundl:56,installer_fomod:56,installer_manu:56,installer_ncc:56,installer_quick:56,installmod:15,installresult:[11,21,22,55],instanc:[19,56,58],instanti:58,instead:[10,56,57,58],int_max:1,integr:[24,26,56],interest:56,interfac:[10,13,15,16,17,23,26,36,53],interfacenotimpl:55,intern:[12,13,15,16,23,46],introduc:58,invalid:[7,10,13,35,47,56,58],invalidationact:27,invok:[26,56],involv:56,iorgan:[21,55,57,58],iplugin:[15,17,18,19,20,24,25,26,52,55,56,57],iplugindiagnos:[55,56],ipluginfilemapp:[55,56],iplugingam:[15,55,56],iplugininstal:[21,22,55,56],iplugininstallercustom:[20,55,56],iplugininstallersimpl:[11,20,55,56],ipluginlist:[13,15,55],ipluginmodpag:[55,56],ipluginpreview:[55,56,58],ipluginproxi:56,iplugintool:[52,55,56,57,58],iprofil:[15,55],irrelev:19,isact:[16,58],isarchivesupport:[20,21],isavegam:[43,52,55],isavegameinfowidget:[43,55],iscustom:3,isdir:5,isdirectori:34,isfil:5,isinst:53,isinstal:[19,44],isinvalidationbsa:0,ismanualinstal:20,ismast:23,issu:[52,56],isvalid:[3,47],item:56,iter:10,its:[5,10,13,15,26,56,58],itself:[19,26,56],json:57,just:56,keep:[13,15],kei:[15,17,39],kept:10,kind:52,know:58,known:[12,19,21],kwd:[5,8,10,15,21,37,47],languag:56,larg:11,last:5,later:58,latest:12,launch:19,launcher:19,layout:35,learn:56,let:56,level:[20,35],librari:[2,19,23],light:6,lightpluginsaresupport:6,like:[5,19,24,26,35,56],limit:[52,56],link:[10,18,24,56],lint:57,list:[1,3,4,6,8,9,11,12,13,14,15,16,17,18,19,21,23,25,26,28,33,36,37,39,43,44,46,52,56,58],listdirectori:15,liter:48,live:10,load:[15,19,23,26,56],loader:44,loadernam:44,loaderpath:44,loadord:23,loadordermechan:[19,55],local:[16,56],localizednam:16,localsavegam:55,localsavesen:27,localsettingsen:27,locat:[10,11,13,15,19,57],lock:[10,15],log:58,look:[19,35],looksvalid:19,loot:45,loss:15,lot:19,made:10,mai:[8,9,10,21,22,46,47],main:[15,16,19,28,46,56],mainli:35,major:47,make:[10,19,56],manag:[9,11,15,19,20,22],managedgam:15,mandatori:[52,57],mani:[10,56,58],manual:[16,20,58],manual_input:47,manual_request:30,map:[10,12,18,19,33,55],master:[23,57],match:[10,15],max_siz:25,maximum:25,mean:[10,24,56,57],mechan:19,memori:[15,22],mention:56,menu:[26,36,56],merg:[10,15],mesh:[25,36,56],messag:58,meta:[7,21,22,56],method:[0,1,2,3,5,6,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,33,35,36,37,43,44,46,47,53,58],might:[13,15,19,23,56,57],mind:[13,19],minim:58,minimum:58,minor:47,miss:[10,40,43,52],mlox:45,mo2:[19,36,56,57,58],mo2dir:57,mobas:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,56,58],mod:[7,9,11,12,13,14,15,19,21,22,23,24,26,35,36,41,46,47,53,58],mod_id:[9,11,14],mod_nam:[11,21,46],mod_vers:14,moddatachang:15,moddatacheck:55,moddatacont:55,modgroup:36,modid:37,modif:5,modifi:[8,15,22,26,35,56,58],modinfo:12,modlist:15,modnam:37,modorgan:[19,57],modorganizer2:[19,57],modrepositoryfileinfo:55,modspath:15,modssortedbyprofileprior:15,modstat:55,modul:[43,57],more:[23,56,58],most:[20,56,58],mostli:56,move:[5,10,11,13,23,57],moveto:5,much:19,multi:35,multipl:[15,19,20,58],multipli:57,music:36,must:[5,10,52],mypi:[52,58],myplugin1:58,myplugin2:58,myplugin:[52,57,58],mypreview:58,mypy_path:57,mypyarg:57,mypyen:57,mypypath:57,mysavegam:52,mytool:58,name:[0,1,5,7,10,11,12,13,14,15,16,19,21,22,23,24,26,27,28,36,37,44,46,57,58],name_suggest:15,ncc:[20,21],need:[11,13,15,20,21,24,26,56,57,58],neither:58,net:56,never:[5,56],newestvers:37,newli:15,nexu:[12,14,15,19,24,56],nexus_id:[12,21,22],nexusgameid:19,nexusmod:[9,19],nexusmodorganizerid:19,node:10,non:13,none:[5,10,15,19,29,37,39,43,45,56],nor:58,normal:[56,58],not_attempt:30,note:[10,15,56,57,58],noth:56,notifi:15,now:[25,56,58],number:[10,47],numbers_and_lett:48,nxm:24,object:[2,3,4,5,8,10,11,12,13,15,22,23,27,28,31,34,37,39,47],obvious:57,occur:12,offer:39,offici:46,official_onli:46,often:52,old:[10,13,15,23],omod:[20,21],onabouttorun:15,onc:[20,24,26],one:[10,13,19,20,23,53,56,58],ones:[56,57,58],onfinishedrun:15,onli:[8,10,15,19,20,22,35,39,46,47,56,58],onmodinstal:15,onmodmov:13,onmodstatechang:13,onpluginmov:23,onpluginsettingchang:15,onprofilechang:15,onrefresh:23,onuserinterfaceiniti:15,open:[11,24,57],oper:[5,10,12,15,20,35,56],option:[5,19,35,43,57],order:[10,15,19,23,26,36,56],org:57,organ:[15,16,19,26,53,56,57,58],origin:[1,4,11,13,15,23],orphan:10,other:[10,13,17,19,23,53,56,58],otheriws:15,otherw:[5,10],otherwis:[5,6,10,12,13,15,16,17,19,20,22,23,24,28,43,44,47,58],our:[57,58],out:56,over:43,overlai:15,overload:[5,8,10,15,21],overrid:[10,52],overriden:10,overwrit:[7,10,15,23,56],overwritepath:15,overwritten:10,own:[19,56,57,58],packag:58,page:[19,24,53,57],page_tesalli:56,page_url:24,pageurl:24,pair:43,pane:[25,56],paramet:[1,5,8,9,10,11,12,13,14,15,16,17,19,20,21,22,23,24,25,26,29,35,36,39,43,46,47,49,50,51],parent:[5,10,20,24,26,29,43],pars:47,part:[19,57],partial:10,particular:16,pass:[8,15],passiv:56,past:57,path:[5,9,10,11,12,15,19,23,25,29,36,43,44,46,49,50,51,57],pathfrom:5,pathto:10,per:15,perform:[10,15,20],persist:15,place:[8,15,23,26,56,58],plan:56,platform:44,pleas:19,plugin:[6,11,15,16,17,18,19,20,21,23,24,25,26,36,39,44,46,47,57],plugin_list:6,plugin_nam:15,plugin_python:56,plugindatapath:15,pluginlist:15,pluginnam:23,pluginpath:44,plugins_txt:32,pluginset:[15,16,55,58],pluginst:55,point:[52,56],pointer:[10,35],polici:10,popul:10,possibl:[10,12,16,24,36,56,57],potenti:19,power:53,practic:[52,56],pre_alpha:42,predic:10,prefer:[56,57],prefer_default:41,prepar:53,prepareprofil:33,present:10,preset:7,press:57,pretti:58,prevent:[10,15],preview:[25,53,58],preview_bas:56,previoui:10,primari:[19,23],primaryplugin:19,primarysourc:19,prior:58,prioriti:[13,15,20,23],probabl:8,problem:[9,17,56],process:[2,10,21,35],product:51,profil:[0,1,15,19,26,28,33,56],profile_save_dir:33,profilenam:15,profilepath:15,profileset:55,program:56,progress:11,project:56,propag:5,proper:57,properli:[13,15,23,56],provid:[5,10,15,16,24,36,56,57,58],proxi:53,puros:19,purpos:[16,39],put:[57,58],pyi:57,pyqt5:[9,14,29,57],pyqtsign:[9,14],pystub:57,python38:57,python:[15,19,20,24,26,52,56,57,58],pythonxx:57,qdatetim:[28,37],qdir:[3,19],qfileinfo:[3,15,46],qicon:[19,24,26,50],qmainwindow:15,qobject:[9,14,53],qtcore:[9,14],qtree:10,qtwidget:29,qualiti:8,queri:[5,8,15,26,56],quickli:35,qurl:24,qwidget:[25,29,53],rais:[5,8,10,15,17,21],rang:47,reach:[5,10],react:56,read:[10,57],readpluginlist:6,real:[15,52],realli:15,reason:[13,15,23],receiv:[13,21],recommend:[15,57],reconstruct:47,recurs:[10,35],refer:[15,46,57],referenc:23,referencefil:46,reflect:10,refresh:[15,23],refreshmodlist:15,regardless:15,regist:[15,56],regular:[13,19,47,48],reinstal:56,reject:8,rel:[15,19,44,58],relat:[15,17,28],releas:57,releasetyp:[55,58],relev:[10,15,56],reli:11,remov:[1,5,10,12,15,56],removeal:10,removearch:1,removecategori:12,removeif:10,removemod:15,renam:[10,21,22],repair:19,replac:[10,15],replace_if_exist:10,report:[17,56],repositori:37,repres:[5,8,19,20,22,35,47],represent:22,request:[14,46,56],requestdescript:14,requestdownloadurl:14,requestfail:14,requestfil:14,requestfileinfo:14,requesttoggleendors:14,requir:[19,23,53,56,58],reset:[8,47],resid:19,resolv:[10,15],resolvepath:15,resourc:[15,36],respons:[21,56],restart:57,result:[11,14,15,21,22],retriev:[1,5,9,10,13,15,16,17,19,20,23,28,36,43,46,49,50,51,58],right:[10,19,25,52,56],root:[5,10,35],rpg:28,rtype:[4,34,37,39],run:[15,19,44],runtimeerror:10,safe:10,safer:15,sai:[8,56],said:52,same:[5,10,15,17,23,28,56],save:[15,19,28,29,43,56],save_chang:15,savegam:[41,43,44],savegameattachmentextens:44,savegameextens:19,savegameinfo:55,savegameinfowidget:43,savegameseextens:19,savesdirectori:19,schema:24,scheme:47,script:[19,28,36,43,44],script_extender_plugin_check:56,scriptextend:55,search:15,second:[13,15,23],secondari:46,secondaryfil:46,see:[15,56,57,58],segment:47,select:[19,56],self:[52,57,58],sens:[10,56],sep:[5,10],separ:[5,10],server:57,session:15,set:[8,11,12,15,16,19,20,21,23,24,26,28,29,36,39,53,58],setact:13,setfilt:8,setgamenam:12,setgamepath:19,setgamevari:19,setinstallationmanag:20,setisendors:12,setloadord:23,setnam:12,setnewestvers:12,setnexusid:12,setparentwidget:[20,24,26],setpersist:15,setpluginset:15,setprior:13,setsav:29,setstat:23,setup:53,seturl:11,setvers:12,shall:56,share:10,shift:57,ship:[1,58],shortdescript:17,should:[7,8,10,11,13,14,15,16,17,19,20,24,26,35,47,56,57,58],show:[11,13,15,25],shown:[11,13,26],silent:11,silli:56,similar:[56,58],simpl:[22,56,57,58],simpler:[19,56],simplest:[26,56],simpli:[26,52,56,58],simul:52,sinc:[19,56,57,58],singl:10,situat:10,size:25,skip:10,skse:36,skyproc:36,skyrim:19,skyrimspecialedit:19,slow:11,snippet:58,solid:11,some:[10,15,19,26,52,56],someon:56,someth:[52,58],somewher:57,sort:[15,19,23,26,56],sortmechan:[19,55],sound:36,sourc:[7,10,12,19,34],space:57,special:24,specif:[19,56],specifi:[8,9,10,11,15,16,19,23,24,25],speicifi:15,stand:17,standard:56,start:[15,17,19,24,26,35,53,57],startappl:15,startdownloadnexusfil:9,startdownloadurl:9,startguidedfix:17,startup:15,state:[12,13,23],statu:57,steam:19,steamappid:[3,19],still:[10,15],stop:10,storag:[15,16],store:[5,15,19,47],str:[1,2,3,4,5,6,8,9,10,11,12,13,15,16,17,19,21,22,23,24,25,26,27,28,34,37,39,43,44,46,47,49,51,58],string:[5,8,10,11,15,16,19,22,23,36,47,49,51],strong:10,structur:[10,12,22,35],stub:52,stuff:43,subdirectori:15,submenu:[26,56],subminor:47,subsubminor:47,subtre:10,succe:[15,22],success:[13,30],successfulli:15,suffix:5,suggest:[11,15,21,22],summari:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48],suppli:43,support:[6,10,11,19,20,25,56],supportedextens:[21,25],sure:53,surround:19,sync:15,system:[12,13,15,18,56],take:56,tannin:58,task:56,technic:23,temporari:11,test:53,text:57,textur:36,than:[13,56],thei:[15,21,23,26,56],them:[19,56,58],themself:21,theoret:53,thew:12,thi:[5,7,8,9,10,11,12,13,15,16,17,19,20,21,22,23,24,25,26,28,29,35,39,43,47,50,52,53,56,57,58],third:[13,23,56],those:[19,36,43,56],thread:10,through:[10,56],thu:[26,56,57],time:[5,8,28],titl:3,took:15,tool:[17,19,26,53,58],tool_configur:56,tool_inibakeri:56,tool_inieditor:56,tooltip:26,top:20,trackedmodsavail:14,trackingtoggl:14,trail:10,transfer:28,translat:13,treat:47,tree:[5,10,11,20,22,35,36,57],tri:56,troubl:57,tupl:[15,22,27],two:[10,56,58],type:[0,1,2,3,4,5,6,8,9,10,11,12,13,15,16,17,18,19,20,21,22,23,24,25,26,27,28,33,34,35,36,37,39,43,44,46,47,49,50,51,53,57,58],unassign:12,under:[10,36,57],underli:52,underlin:57,understand:58,union:[10,15,22,37,39],unknown:[21,22],unless:[10,15,24,56,58],unlock:15,unmanag:46,unmanagedmod:55,unpack:56,unreach:5,unsupportedoperationexcept:10,updat:[8,12,15,47,56],upgrad:19,uplink:10,upon:10,uri:37,url:[9,11,14,19,24],usabl:24,usag:10,use:[5,10,13,15,16,20,22,26,44,47,56,57,58],used:[5,7,8,10,11,12,15,16,17,19,20,24,28,35,36,56,57,58],usefulness:56,useintegratedbrows:24,user:[7,13,14,15,16,19,24,26,35,36,39,47,56,58],user_data:14,userdata:37,uses:19,using:[10,15,16,19,20,24,26,47,56,57,58],usual:[20,23,24,26,28,56,58],valid:[10,12,17,19,35,38,47,57,58],validshortnam:19,valu:[8,12,15,39,47],valueerror:17,vanilla:1,vanillaarch:1,variabl:57,variant:[8,19],veri:11,verifi:15,version:[12,14,15,16,19,21,22,37,44,47,49,51,56,57,58],versioninfo:[15,16,37,55,58],versionschem:[47,55],view:56,virtual:[13,15,18,19,56,57],virtualis:4,visit:24,visual:10,volunt:56,wai:[10,13,16,53,56,57,58],wait:15,waitforappl:15,walk:10,walkreturn:10,want:[24,56,57,58],warn:[52,58],weak:10,well:57,were:[11,13,19,23,58],what:[10,15,20,22,28,39,56,57],when:[5,8,10,13,15,17,19,21,23,24,26,35,36,53,56,58],where:[15,19,22,56],wherev:56,whether:[15,35,43,56],which:[11,14,15,17,19,21,23,35,52,57,58],whole:[56,58],why:53,widget:[10,20,24,25,26,29,43],win:20,window:[15,26,56,57],wip:56,wish:19,withargu:3,withen:2,withforc:2,within:58,without:[10,23,56],withsteamappid:3,withworkingdirectori:3,work:[13,15,20,53,56,57],workingdirectori:3,workspac:57,would:56,writ:[53,56,57],write:[19,53,56,57],writepluginlist:6,written:[15,19,57],wrong:10,www:[9,19,57],xxx:58,yet:[9,10,15,19,21],you:[13,15,16,19,52,53,56,57,58],your:[56,57,58],yourself:15},titles:["BSAInvalidation","DataArchives","ExecutableForcedLoadSetting","ExecutableInfo","FileInfo","FileTreeEntry","GamePlugins","GuessQuality","GuessedString","IDownloadManager","IFileTree","IInstallationManager","IModInterface","IModList","IModRepositoryBridge","IOrganizer","IPlugin","IPluginDiagnose","IPluginFileMapper","IPluginGame","IPluginInstaller","IPluginInstallerCustom","IPluginInstallerSimple","IPluginList","IPluginModPage","IPluginPreview","IPluginTool","IProfile","ISaveGame","ISaveGameInfoWidget","InstallResult","InterfaceNotImplemented","LoadOrderMechanism","LocalSavegames","Mapping","ModDataChecker","ModDataContent","ModRepositoryFileInfo","ModState","PluginSetting","PluginState","ProfileSetting","ReleaseType","SaveGameInfo","ScriptExtender","SortMechanism","UnmanagedMods","VersionInfo","VersionScheme","getFileVersion","getIconForExecutable","getProductVersion","FAQ","Welcome to MO2 Python Plugin API\u2019s documentation!","mobase API","mobase","Type of Plugins","Setting up the environment","Writing Plugins"],titleterms:{"class":[52,54],"function":54,"throw":52,"try":52,all:52,api:[53,54],bsainvalid:0,can:52,code:57,configur:57,creat:52,dataarch:1,diagnos:56,document:53,environ:57,except:52,executableforcedloadset:2,executableinfo:3,extens:56,faq:52,file:[56,58],fileinfo:4,filetreeentri:5,find:57,free:56,game:56,gameplugin:6,get:[57,58],getfilevers:49,geticonforexecut:50,getproductvers:51,guessedstr:8,guessqual:7,how:52,idownloadmanag:9,ifiletre:10,iinstallationmanag:11,imodinterfac:12,imodlist:13,imodrepositorybridg:14,implement:52,inherit:52,instal:56,installresult:30,interfac:[56,58],interfacenotimpl:31,iorgan:15,iplugin:[16,58],iplugindiagnos:17,ipluginfilemapp:18,iplugingam:19,iplugininstal:20,iplugininstallercustom:21,iplugininstallersimpl:22,ipluginlist:23,ipluginmodpag:24,ipluginpreview:25,iplugintool:26,iprofil:27,isavegam:28,isavegameinfowidget:29,isinst:52,loadordermechan:32,localsavegam:33,map:[34,56],method:52,mo2:[52,53],mobas:[54,55,57],mod:56,moddatacheck:35,moddatacont:36,modrepositoryfileinfo:37,modstat:38,modul:58,mypi:57,one:52,page:56,plugin:[52,53,56,58],pluginset:39,pluginst:40,prepar:57,preview:56,profileset:41,proxi:56,python:53,qobject:52,qwidget:52,releasetyp:42,requir:[52,57],savegameinfo:43,scriptextend:44,set:57,setup:57,singl:58,sortmechan:45,start:58,stub:57,studio:57,sure:52,test:57,tool:[56,57],type:[52,56],unmanagedmod:46,versioninfo:47,versionschem:48,visual:57,welcom:53,when:52,why:52,work:52,write:58}}) \ No newline at end of file diff --git a/gh-pages/setup-tools.html b/gh-pages/setup-tools.html deleted file mode 100644 index f4d3288..0000000 --- a/gh-pages/setup-tools.html +++ /dev/null @@ -1,435 +0,0 @@ - - - - - - - - - - Setting up the environment — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

Setting up the environmentĀ¶

-

This page will get you started for creating a MO2 python plugin. If you have troubles getting -everything setup, feel free to come by our discord server at https://discord.gg/cYwdcxj.

-
-

Required toolsĀ¶

-

It is possible to write a MO2 python plugin using any text editor, but this guide will focus on -Visual Studio Code. -This guide assumes that:

- -

Note: In the following, I will refer to the MO2 installation directory as $MO2DIR. So if you -installed MO2 at C:\MO2 and you are asked to copy a file to $MO2DIR/plugins, it refers to C:\MO2\plugins.

-
-
-

PreparationĀ¶

-

Note: This part is optional but highly recommended if you want a proper environment to work with. -Everything here is written to be as simple as possible but you can of course adapt it to your preferences: use a python virtual -environment, use workspace settings instead of global ones, etc.

-
-

1. Get the mobase stubsĀ¶

-

mobase is the MO2 Python module. The module is written in C++ and thus cannot be read directly by tools such -as flake8 or mypy. -Instead, we provide stubs -which can be used for auto-completion or type-checking.

-

The stubs for mobase are available at https://github.com/ModOrganizer2/pystubs-generation/tree/master/stubs. -You want to download the mobase.pyi file in the folder corresponding to your MO2 version and put it under $MO2DIR/plugins/data.

-

Note: It is possible to put the stubs in a different location, but we are going to use $MO2DIR/plugins/data for PyQt5, -so we might as well use it for the stubs.

-
-
-

2. Configure Visual Studio Code for mobaseĀ¶

-

We are going to configure Visual Studio Code to have auto-completion and linting (error and type checking) -for the MO2 Python module. -Open settings.json (Ctrl+Shift+P, then ā€œOpen Settings (JSON)ā€), and add the following entries:

-
"python.linting.enabled": true,
-"python.linting.mypyEnabled": true,
-"python.linting.flake8Enabled": true,
-"python.autoComplete.extraPaths": [
-    "$MO2DIR\\plugins\\data",
-]
-
-
-
-
-

3. Configure mypy to find the mobase stubsĀ¶

-

There are multiply way to configure mypy:

-
    -

  1. You can create a mypy.ini file somewhere containing:

    2. -
-
[mypy]
-mypy_path = $MO2DIR\plugins\data
-
-
-

And then add the following to settings.json (with the correct path):

-
"python.linting.mypyArgs": [
-    "--config-file=path-to-mypy.ini",
-]
-
-
-

2. You can set the MYPYPATH environment variable to $MO2DIR\plugins\data (this requires -restarting VS code).

-
-
-
-

Testing the setupĀ¶

-

Create a new Python file in Visual Studio Code, and paste the following content (if you create -the file in $MO2DIR\plugins, do not forget to delete it after since it is not a valid -plugin):

-
import mobase
-
-
-class MyPlugin(mobase.IPluginTool):
-    def __init__(self):
-        super().__init__()
-
-    def init(self, organizer: mobase.IOrganizer) -> bool:
-        organizer.dow  # (1)
-        return True
-
-    def name(self) -> int:
-        return 0
-
-
-def createPlugin() -> mobase.IPlugin:
-    return MyPlugin()
-
-
-

If your setup is valid, here is what you should have.

-
    -

  • You should see the following (with the errors underlined):

    • -
-_images/check-setup-1.png -
    -

  • If you press Ctrl+Space after .down (1), you should see the following -meaning that auto-complete is working:

    • -
-_images/check-setup-2.png -
    -

  • In the error window (click error-window on the status bar), you should see -the 3 following errors:

    • -
-_images/check-setup-3.png -

If everything is as above, you can delete the test file and move on to writting -your own plugin!

-
-
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/gh-pages/writing-plugins.html b/gh-pages/writing-plugins.html deleted file mode 100644 index 568d364..0000000 --- a/gh-pages/writing-plugins.html +++ /dev/null @@ -1,488 +0,0 @@ - - - - - - - - - - Writing Plugins — MO2 Python Plugin API 2.3rc1 documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

Writing PluginsĀ¶

-
-

Getting startedĀ¶

-

Now that you know which type of plugin you need, you can start writing your own plugin. -There is two way to write a Python plugin:

-
    -

  • Single file plugins: You use a single .py file that you put directly in the plugins -folder of the MO2 installation.

    • -

  • Module Plugins: You create a Python package (folder) with a __init__.py file that you -put in the plugins folder of the MO2 installation.

    • -
-

Most examples of plugins will be module plugins.

-
-

Single file pluginsĀ¶

-

Prior to version 2.3, this was the only way of creating a Python plugin. You simply need -to create a myplugin.py file in the plugins folder of Mod Organizer 2 with a content -similar to:

-
import mobase
-
-class MyPlugin(...):
-    ...
-
-def createPlugin() -> mobase.IPlugin:
-    return MyPlugin()
-
-
-

We will see later on how to create the actual MyPlugin class. -The createPlugin function is the function that is called by Mod Organizer 2 to instantiate -the plugin.

-

You can also provide multiple plugins by using createPlugins instead of createPlugin:

-
from typing import List
-
-import mobase
-
-class MyPlugin1(...):
-    ...
-
-class MyPlugin2(...):
-    ...
-
-
-def createPlugins() -> List[mobase.IPlugin]:
-    return [MyPlugin1(), MyPlugin2()]
-
-
-

Note: If you provide neither createPlugin() nor createPlugins, MO2 will display -an error message in the logs.

-

Note: If you add a return type-hint to createPlugin() or createPlugins (->), mypy -will type-check the function and warn you if one of your plugins is invalid, e.g. if you -forgot to implement a required method.

-

If you need to provide other files with your .py (assets or other Python files), you can -put them in the plugins/data, but this is deprecated since MO2 2.3, and you should instead -create a Python module plugin.

-
-
-

Module PluginsĀ¶

-

Module plugins were introduced in MO2 2.3 and are shipped as whole folder containg a python module. -The minimum content of the folder is a __init__.py file with createPlugin or createPlugins -function.

-

A minimal module plugin could be as follows:

-
plugins/               # MO2 plugins folder
-    myplugin/
-        __init__.py
-        plugin.py
-
-
-

In plugin.py, you could define your plugin:

-
# plugin.py
-
-import mobase
-
-class MyPlugin(...):
-    ...
-
-
-

And in __init__.py, you should write createPlugin:

-
# __init__.py
-
-import mobase  # For type-checking createPlugin().
-
-from .plugin import MyPlugin  # Always use relative import:
-
-def createPlugin() -> mobase.IPlugin:
-    return MyPlugin()
-
-
-

Similar to single-file plugins, you can expose createPlugins instead of createPlugin -to instantiate multiple plugins.

-

Note: The name of the folder does not have to be a valid python package, and you should -always use relative imports within the module (import .xxx) instead of absolute ones.

-
-
-
-

Writing the pluginĀ¶

-
-

IPlugin interfaceĀ¶

-

In the code snippets above, the MyPlugin class was not implemented. -Depending on the type of plugins that you want to create, you will -need to extend a different class.

-
class MyTool(mobase.IPluginTool):  # Create a Tool plugin
-    ...
-
-class MyPreview(mobase.IPluginPreview):  # Create a preview plugin
-    ...
-
-
-

Each plugin class has its own abstract methods that you need to implement but all the classes -also extend IPlugin, so you need to implement the methods from IPlugin:

-
from typing import List
-
-import mobase
-
-class MyPlugin(...):  # The base class depends on the actual type of plugin
-
-    _organizer: mobase.IOrganizer
-
-    def __init__(self):
-        super().__init__()  # You need to call this manually.
-
-    def init(self, organizer: mobase.IOrganizer):
-        self._organizer = organizer
-        return True
-
-    def name(self) -> str:
-        return ""
-
-    def author(self) -> str:
-        return "Tannin"
-
-    def description(self) -> str:
-        return self._tr("Gives a friendly greeting")
-
-    def version(self) -> mobase.VersionInfo:
-        return mobase.VersionInfo(1, 0, 0, mobase.ReleaseType.FINAL)
-
-    def isActive(self) -> bool:
-        return self._organizer.pluginSetting(self.name(), "enabled")
-
-    def settings(self) -> List[mobase.PluginSetting]:
-        return [
-            mobase.PluginSetting("enabled", "enable this plugin", True)
-        ]
-
-
-

Most of these are pretty simple to understand:

-
    -

  • name: Returns the name of the plugin. The name of the plugin is used to -fetch settings, and in many places, so this should not change between versions.

    • -

  • author: Returns the name of the plugin author (you!).

    • -

  • description: Returns the description of the plugin.

    • -

  • version: Returns the version of the plugin. See VersionInfo for -more details.

    • -

  • isActive: Returns True if the plugin is active, False otherwise. This -usually returns True, unless you want to check for something to dynamically -enable the plugin. You can also use a plugin setting to allow users to disable -your plugins.

    • -

  • settings: Returns the list of settings (that user can modify) for this plugin. -Settings can be int`, bool, str or list of str. Here we indicate -that we have a ā€œenabledā€ setting that user could use to disable the plugin (and -we use it in isActive).

    • -
-

The __init__ method is the normal Python constructor for our plugin, called when doing -MyPlugin(). -You should always call super().__init__() explicitly when extending MO2 classes (due to -a ā€œbugā€ in boost.python).

-

The init method is called by MO2 to initialize the plugin. The given argument, organizer, -is an instance of IOrganizer which is the class used to interface with MO2. -Here, we use it in the isActive() method to retrieve the ā€œenabledā€ setting for our plugin. -See IOrganizer for more details.

-
-
-
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/main.py b/main.py deleted file mode 100644 index 474b836..0000000 --- a/main.py +++ /dev/null @@ -1,167 +0,0 @@ -# -*- encoding: utf-8 -*- - -import argparse -import logging -import sys - -from pathlib import Path - -import black - -from generator import logger -from generator.loader import load_mobase -from generator.register import MOBASE_REGISTER -from generator.parser import is_enum -from generator.mtypes import Type, Class, Function -from generator.utils import Settings, clean_class -from generator.writer import Writer - - -parser = argparse.ArgumentParser("Stubs generator for the MO2 python interface") -parser.add_argument( - "install_dir", - metavar="INSTALL_DIR", - type=Path, - default=None, - help="installation directory of Mod Organizer 2", -) -parser.add_argument( - "-o", - "--output", - type=Path, - default=sys.stdout, - help="output file (output to stdout if not specified)", -) -parser.add_argument( - "-v", "--verbose", action="store_true", help="verbose mode (all logs go to stderr)" -) -parser.add_argument( - "-c", - "--config", - type=argparse.FileType("r"), - default=None, - help="configuration file", -) - -args = parser.parse_args() - -if args.verbose: - logger.setLevel(logging.INFO) - -# Load settings from the configuration: -settings: Settings = Settings(register=MOBASE_REGISTER) -if args.config is not None: - settings = Settings(MOBASE_REGISTER, args.config) - -# Parse mobase: - -# Load mobase (cannot simply do "import mobase"): -mobase = load_mobase(Path(args.install_dir)) - -# List of objects: -objects = [] - -for name in dir(mobase): - if name.startswith("__"): - continue - - if name in settings.ignore_names: - continue - - # We do not want the real MoVariant. - if name == "MoVariant": - continue - - objects.append((name, getattr(mobase, name))) - -# Enum first, and then alphabetical. Might cause issue with base classes, so -# maybe create a kind of dependency... -# For argument or return types, this should not be an issue since we quote -# everything from mobase. -objects = sorted( - objects, key=lambda e: (isinstance(e[1], type), not is_enum(e[1]), e[0]) -) - -for n, o in objects: - MOBASE_REGISTER.add_object(n, o) - -# Process everything: -for n, o in objects: - - # Create the corresponding object: - c = MOBASE_REGISTER.make_object(n, o) - - if isinstance(c, Class): - - # Clean the class (e.g., remove duplicates methods due to wrappers): - clean_class(c, settings) - - # Path the class using the configuration: - settings.patch_class(c) - - elif isinstance(c, list) and isinstance(c[0], Function): - settings.patch_functions(c) - - else: - logger.critical( - "Cannot generated stubs for {}, unsupported object type.".format(n) - ) - -# Write everything: -with open(args.output, "w") as output: - - writer = Writer(output, settings) - writer.print_version(settings.mobase["__version__"]) # type: ignore - writer.print_imports( - [ - "abc", - ("enum", ["Enum"]), - ( - "typing", - [ - "Dict", - "Iterator", - "List", - "Tuple", - "Union", - "Any", - "Optional", - "Callable", - "overload", - "TypeVar", - "Type", - ], - ), - "PyQt5.QtCore", - "PyQt5.QtGui", - "PyQt5.QtWidgets", - ] - ) - - # Needs to define the MVariant and GameFeatureType type: - writer._print("MoVariant = {}".format(Type.MO_VARIANT)) - writer._print('GameFeatureType = TypeVar("GameFeatureType")') - writer._print() - - # This is a class to represent interface not implemented: - writer.print_class(Class("InterfaceNotImplemented", [], [])) - writer._print() - - for n, o in objects: - - # Get the corresponding object: - c = MOBASE_REGISTER.get_object(n) - - if isinstance(c, Class): - writer.print_class(c) - - elif isinstance(c, list) and isinstance(c[0], Function): - for fn in c: - writer.print_function(fn) - -black.format_file_in_place( - args.output, - fast=False, - mode=black.Mode(is_pyi=args.output.name.endswith("pyi")), - write_back=black.WriteBack.YES, -) diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 62f7e61..0000000 --- a/setup.cfg +++ /dev/null @@ -1,16 +0,0 @@ -[flake8] -# Use black line length: -max-line-length = 88 -extend-ignore = - # See https://github.com/PyCQA/pycodestyle/issues/373 - E203, -per-file-ignores = - *.pyi: E301, E302, E305, E501, E701, E741, F401, F403, F405, F822 - # Since typing.pyi defines "overload" this is not recognized by flake8 as typing.overload. - # Unfortunately, flake8 does not allow to "noqa" just a specific error inside the file itself. - typing.pyi: E301, E302, E305, E501, E701, E741, F401, F403, F405, F811, F822 - -[mypy] -warn_return_any = True -warn_unused_configs = True -namespace_packages = True diff --git a/stubs/2.2.2.1/mobase.pyi b/stubs/2.2.2.1/mobase.pyi deleted file mode 100644 index 8c45186..0000000 --- a/stubs/2.2.2.1/mobase.pyi +++ /dev/null @@ -1,836 +0,0 @@ -__version__ = "2.2.2.1" - -from enum import Enum -from typing import ( - Dict, - Iterable, - Iterator, - List, - Tuple, - Union, - Any, - Optional, - Callable, - overload, -) -import PyQt5.QtCore -import PyQt5.QtGui -import PyQt5.QtWidgets - -MoVariant = Union[bool, int, str, List[Any], Dict[str, Any]] - -class InterfaceNotImplemented: - pass - -class GuessQuality(Enum): - invalid = ... - fallback = ... - good = ... - meta = ... - preset = ... - user = ... - -class InstallResult(Enum): - success = ... - failed = ... - canceled = ... - manualRequested = ... - notAttempted = ... - -class LoadOrderMechanism(Enum): - FileTime = ... - PluginsTxt = ... - -class ModState(Enum): - exists = ... - active = ... - essential = ... - empty = ... - endorsed = ... - valid = ... - alternate = ... - -class PluginState(Enum): - missing = ... - inactive = ... - active = ... - -class ProfileSetting(Enum): - mods = ... - configuration = ... - savegames = ... - preferDefaults = ... - -class ReleaseType(Enum): - prealpha = ... - alpha = ... - beta = ... - candidate = ... - final = ... - -class SortMechanism(Enum): - NONE = ... - MLOX = ... - BOSS = ... - LOOT = ... - -class VersionScheme(Enum): - discover = ... - regular = ... - decimalmark = ... - numbersandletters = ... - date = ... - literal = ... - -class BSAInvalidation: - def __init__(self): - pass - def activate(self, arg1: "IProfile"): - pass - def deactivate(self, arg1: "IProfile"): - pass - def isInvalidationBSA(self, arg1: str) -> bool: - pass - -class DataArchives: - def __init__(self): - pass - def addArchive(self, arg1: "IProfile", arg2: int, arg3: str): - pass - def archives(self, arg1: "IProfile") -> List[str]: - pass - def removeArchive(self, arg1: "IProfile", arg2: str): - pass - def vanillaArchives(self) -> List[str]: - pass - -class ExecutableInfo: - def __init__(self, arg1: str, arg2: PyQt5.QtCore.QFileInfo): - pass - def arguments(self) -> List[str]: - pass - def asCustom(self) -> "ExecutableInfo": - pass - def binary(self) -> PyQt5.QtCore.QFileInfo: - pass - def isCustom(self) -> bool: - pass - def isValid(self) -> bool: - pass - def steamAppID(self) -> str: - pass - def title(self) -> str: - pass - def withArgument(self, arg1: str) -> "ExecutableInfo": - pass - def withSteamAppId(self, arg1: str) -> "ExecutableInfo": - pass - def withWorkingDirectory(self, arg1: PyQt5.QtCore.QDir) -> "ExecutableInfo": - pass - def workingDirectory(self) -> PyQt5.QtCore.QDir: - pass - -class GamePlugins: - def __init__(self): - pass - def getLoadOrder(self, arg1: List[str]): - pass - def lightPluginsAreSupported(self) -> bool: - pass - def readPluginLists(self, arg1: "IPluginList"): - pass - def writePluginLists(self, arg1: "IPluginList"): - pass - -class GuessedString: - def __init__(self): - pass - def update(self, arg1: str, arg2: "GuessQuality") -> "GuessedString": - pass - def variants(self) -> List[str]: - pass - -class IDownloadManager(PyQt5.QtCore.QObject): - downloadComplete: PyQt5.QtCore.pyqtSignal = ... # downloadComplete[int] - downloadPaused: PyQt5.QtCore.pyqtSignal = ... # downloadPaused[int] - downloadFailed: PyQt5.QtCore.pyqtSignal = ... # downloadFailed[int] - downloadRemoved: PyQt5.QtCore.pyqtSignal = ... # downloadRemoved[int] - def __init__(self): - pass - def downloadPath(self, arg1: int) -> str: - pass - def startDownloadNexusFile(self, arg1: int, arg2: int) -> int: - pass - def startDownloadURLs(self, arg1: List[str]) -> int: - pass - -class IInstallationManager: - def __init__(self): - pass - def extractFile(self, arg1: str) -> str: - pass - def extractFiles(self, arg1: List[str], arg2: bool) -> List[str]: - pass - def installArchive( - self, arg1: "GuessedString", arg2: str, arg3: int - ) -> "InstallResult": - pass - def setURL(self, arg1: str): - pass - -class IModInterface: - def __init__(self): - pass - def absolutePath(self) -> str: - pass - def addCategory(self, arg1: str): - pass - def addNexusCategory(self, arg1: int): - pass - def categories(self) -> List[str]: - pass - def name(self) -> str: - pass - def remove(self) -> bool: - pass - def removeCategory(self, arg1: str) -> bool: - pass - def setGameName(self, arg1: str): - pass - def setIsEndorsed(self, arg1: bool): - pass - def setName(self, arg1: str) -> bool: - pass - def setNewestVersion(self, arg1: VersionInfo): - pass - def setNexusID(self, arg1: int): - pass - def setVersion(self, arg1: VersionInfo): - pass - -class IModList: - def __init__(self): - pass - def allMods(self) -> List[str]: - pass - def displayName(self, arg1: str) -> str: - pass - def onModMoved(self, arg1: Callable[[str, int, int], None]) -> bool: - pass - def onModStateChanged(self, arg1: Callable[[str, int], None]) -> bool: - pass - def priority(self, arg1: str) -> int: - pass - def setActive(self, arg1: str, arg2: bool) -> bool: - pass - def setPriority(self, arg1: str, arg2: int) -> bool: - pass - def state(self, arg1: str) -> int: - pass - -class IModRepositoryBridge(PyQt5.QtCore.QObject): - descriptionAvailable: PyQt5.QtCore.pyqtSignal = ( - ... - ) # descriptionAvailable[str, int, QVariant, QVariant] - filesAvailable: PyQt5.QtCore.pyqtSignal = ( - ... - ) # filesAvailable[str, int, QVariant, List[ModRepositoryFileInfo]] - fileInfoAvailable: PyQt5.QtCore.pyqtSignal = ( - ... - ) # fileInfoAvailable[str, int, int, QVariant, QVariant] - downloadURLsAvailable: PyQt5.QtCore.pyqtSignal = ( - ... - ) # downloadURLsAvailable[str, int, int QVariant, QVariant] - endorsementsAvailable: PyQt5.QtCore.pyqtSignal = ( - ... - ) # endorsementsAvailable[QVariant, QVariant] - endorsementToggled: PyQt5.QtCore.pyqtSignal = ( - ... - ) # endorsementToggled[str, int, QVariant, QVariant] - trackedModsAvailable: PyQt5.QtCore.pyqtSignal = ( - ... - ) # trackedModsAvailable[QVariant, QVariant] - trackingToggled: PyQt5.QtCore.pyqtSignal = ( - ... - ) # trackingToggled[str, int, QVariant, bool] - requestFailed: PyQt5.QtCore.pyqtSignal = ( - ... - ) # requestFailed[str, int, int, QVariant, NetworkError, str] - def __init__(self): - pass - def requestDescription(self, arg1: str, arg2: int, arg3: MoVariant): - pass - def requestDownloadURL(self, arg1: str, arg2: int, arg3: int, arg4: MoVariant): - pass - def requestFileInfo(self, arg1: str, arg2: int, arg3: int, arg4: MoVariant): - pass - def requestFiles(self, arg1: str, arg2: int, arg3: MoVariant): - pass - def requestToggleEndorsement( - self, arg1: str, arg2: int, arg3: str, arg4: bool, arg5: MoVariant - ): - pass - -class IOrganizer: - def __init__(self): - pass - def appVersion(self) -> VersionInfo: - pass - def basePath(self) -> str: - pass - def createMod(self, arg1: "GuessedString") -> "IModInterface": - pass - def createNexusBridge(self) -> "IModRepositoryBridge": - pass - def downloadManager(self) -> "IDownloadManager": - pass - def downloadsPath(self) -> str: - pass - def findFileInfos( - self, arg1: str, arg2: Callable[[FileInfo], bool] - ) -> List[FileInfo]: - pass - def findFiles(self, arg1: str, arg2: Callable[[str], bool]) -> List[str]: - pass - def getFileOrigins(self, arg1: str) -> List[str]: - pass - def getGame(self, arg1: str) -> "IPluginGame": - pass - def getMod(self, arg1: str) -> "IModInterface": - pass - def installMod(self, arg1: str, arg2: str = "") -> "IModInterface": - pass - def listDirectories(self, arg1: str) -> List[str]: - pass - def managedGame(self) -> "IPluginGame": - pass - def modDataChanged(self, arg1: "IModInterface"): - pass - def modList(self) -> "IModList": - pass - def modsPath(self) -> str: - pass - def modsSortedByProfilePriority(self) -> List[str]: - pass - def onAboutToRun(self, arg1: Callable[[str], bool]) -> bool: - pass - def onFinishedRun(self, arg1: Callable[[str, int], None]) -> bool: - pass - def onModInstalled(self, arg1: Callable[[str], None]) -> bool: - pass - def overwritePath(self) -> str: - pass - def persistent(self, arg1: str, arg2: str, arg3: MoVariant) -> MoVariant: - pass - def pluginDataPath(self) -> str: - pass - def pluginList(self) -> "IPluginList": - pass - def pluginSetting(self, arg1: str, arg2: str) -> MoVariant: - pass - def profile(self) -> "IProfile": - pass - def profileName(self) -> str: - pass - def profilePath(self) -> str: - pass - def refreshModList(self, arg1: bool): - pass - def removeMod(self, arg1: "IModInterface") -> bool: - pass - def resolvePath(self, arg1: str) -> str: - pass - def setPersistent(self, arg1: str, arg2: str, arg3: MoVariant, arg4: bool): - pass - def setPluginSetting(self, arg1: str, arg2: str, arg3: MoVariant): - pass - def startApplication( - self, - arg1: str, - arg2: List[str] = None, - arg3: str = "", - arg4: str = "", - arg5: str = "", - arg6: bool = False, - ) -> "object": - pass - @staticmethod - def waitForApplication(arg0: "object", arg1: int) -> object: - pass - -class IPlugin: - def __init__(self): - pass - -class IPluginDiagnose: - def __init__(self): - pass - def _invalidate(self): - pass - def activeProblems(self) -> List[int]: - pass - def fullDescription(self, arg1: int) -> str: - pass - def hasGuidedFix(self, arg1: int) -> bool: - pass - def shortDescription(self, arg1: int) -> str: - pass - def startGuidedFix(self, arg1: int): - pass - -class IPluginFileMapper: - def __init__(self): - pass - def mappings(self) -> List[Mapping]: - pass - -class IPluginGame: - def __init__(self): - pass - def CCPlugins(self) -> List[str]: - pass - def DLCPlugins(self) -> List[str]: - pass - def author(self) -> str: - pass - def binaryName(self) -> str: - pass - def dataDirectory(self) -> PyQt5.QtCore.QDir: - pass - def description(self) -> str: - pass - def documentsDirectory(self) -> PyQt5.QtCore.QDir: - pass - def executables(self) -> List[ExecutableInfo]: - pass - def featureBSAInvalidation(self) -> "BSAInvalidation": - pass - def featureDataArchives(self) -> "DataArchives": - pass - def featureGamePlugins(self) -> "GamePlugins": - pass - def featureLocalSavegames(self) -> "LocalSavegames": - pass - def featureSaveGameInfo(self) -> "SaveGameInfo": - pass - def featureScriptExtender(self) -> "ScriptExtender": - pass - def featureUnmanagedMods(self) -> "UnmanagedMods": - pass - def gameDirectory(self) -> PyQt5.QtCore.QDir: - pass - def gameIcon(self) -> PyQt5.QtGui.QIcon: - pass - def gameName(self) -> str: - pass - def gameNexusName(self) -> str: - pass - def gameShortName(self) -> str: - pass - def gameVariants(self) -> List[str]: - pass - def gameVersion(self) -> str: - pass - def getLauncherName(self) -> str: - pass - def iniFiles(self) -> List[str]: - pass - def init(self, arg1: "IOrganizer") -> bool: - pass - def initializeProfile(self, arg1: PyQt5.QtCore.QDir, arg2: int): - pass - def isActive(self) -> bool: - pass - def isInstalled(self) -> bool: - pass - def loadOrderMechanism(self) -> "LoadOrderMechanism": - pass - def looksValid(self, arg1: PyQt5.QtCore.QDir) -> bool: - pass - def name(self) -> str: - pass - def nexusGameID(self) -> int: - pass - def nexusModOrganizerID(self) -> int: - pass - def primaryPlugins(self) -> List[str]: - pass - def primarySources(self) -> List[str]: - pass - def savegameExtension(self) -> str: - pass - def savegameSEExtension(self) -> str: - pass - def savesDirectory(self) -> PyQt5.QtCore.QDir: - pass - def setGamePath(self, arg1: str): - pass - def setGameVariant(self, arg1: str): - pass - def settings(self) -> List[PluginSetting]: - pass - def sortMechanism(self) -> "SortMechanism": - pass - def steamAPPId(self) -> str: - pass - def validShortNames(self) -> List[str]: - pass - def version(self) -> VersionInfo: - pass - -class IPluginInstallerCustom: - def __init__(self): - pass - def setParentWidget(self, arg1: PyQt5.QtWidgets.QWidget): - pass - -class IPluginList: - def __init__(self): - pass - def isMaster(self, arg1: str) -> bool: - pass - def loadOrder(self, arg1: str) -> int: - pass - def masters(self, arg1: str) -> List[str]: - pass - def onPluginMoved(self, arg1: Callable[[str, int, int], None]) -> bool: - pass - def onRefreshed(self, arg1: Callable[[None], None]) -> bool: - pass - def origin(self, arg1: str) -> str: - pass - def pluginNames(self) -> List[str]: - pass - def priority(self, arg1: str) -> int: - pass - def setLoadOrder(self, arg1: List[str]): - pass - def setState(self, arg1: str, arg2: int): - pass - def state(self, arg1: str) -> int: - pass - -class IPluginModPage: - def __init__(self): - pass - def setParentWidget(self, arg1: PyQt5.QtWidgets.QWidget): - pass - -class IPluginPreview: - def __init__(self): - pass - -class IPluginTool(IPlugin): - def __init__(self): - pass - def setParentWidget(self, arg1: PyQt5.QtWidgets.QWidget): - pass - -class IProfile: - def __init__(self): - pass - def absolutePath(self) -> str: - pass - def invalidationActive(self, arg1: InterfaceNotImplemented) -> bool: - pass - def localSavesEnabled(self) -> bool: - pass - def localSettingsEnabled(self) -> bool: - pass - def name(self) -> str: - pass - -class ISaveGame: - def __init__(self): - pass - def allFiles(self) -> List[str]: - pass - def getCreationTime(self) -> PyQt5.QtCore.QDateTime: - pass - def getFilename(self) -> str: - pass - def getSaveGroupIdentifier(self) -> str: - pass - def hasScriptExtenderFile(self) -> bool: - pass - -class LocalSavegames: - def __init__(self): - pass - def mappings(self, arg1: PyQt5.QtCore.QDir) -> List[Mapping]: - pass - def prepareProfile(self, arg1: "IProfile") -> bool: - pass - -class Mapping: - @property - def createTarget(self) -> bool: - pass - @createTarget.setter - def createTarget(self, arg0: bool): - pass - @property - def destination(self) -> str: - pass - @destination.setter - def destination(self, arg0: str): - pass - @property - def isDirectory(self) -> bool: - pass - @isDirectory.setter - def isDirectory(self, arg0: bool): - pass - @property - def source(self) -> str: - pass - @source.setter - def source(self, arg0: str): - pass - def __init__(self): - pass - -class ModRepositoryBridge: - @overload - def __init__(self): - pass - @overload - def __init__(self, arg1: "IModRepositoryBridge"): - pass - def onDescriptionAvailable(self, arg1: "object"): - pass - def onEndorsementToggled(self, arg1: "object"): - pass - def onFileInfoAvailable(self, arg1: "object"): - pass - def onFilesAvailable(self, arg1: "object"): - pass - def onRequestFailed(self, arg1: "object"): - pass - def requestDescription(self, arg1: str, arg2: int, arg3: MoVariant): - pass - def requestFileInfo(self, arg1: str, arg2: int, arg3: int, arg4: MoVariant): - pass - def requestFiles(self, arg1: str, arg2: int, arg3: MoVariant): - pass - def requestToggleEndorsement( - self, arg1: str, arg2: int, arg3: str, arg4: bool, arg5: MoVariant - ): - pass - -class ModRepositoryFileInfo: - @property - def categoryID(self) -> int: - pass - @categoryID.setter - def categoryID(self, arg0: int): - pass - @property - def description(self) -> str: - pass - @description.setter - def description(self, arg0: str): - pass - @property - def fileCategory(self) -> int: - pass - @fileCategory.setter - def fileCategory(self, arg0: int): - pass - @property - def fileID(self) -> int: - pass - @fileID.setter - def fileID(self, arg0: int): - pass - @property - def fileName(self) -> str: - pass - @fileName.setter - def fileName(self, arg0: str): - pass - @property - def fileSize(self) -> int: - pass - @fileSize.setter - def fileSize(self, arg0: int): - pass - @property - def fileTime(self) -> PyQt5.QtCore.QDateTime: - pass - @fileTime.setter - def fileTime(self, arg0: PyQt5.QtCore.QDateTime): - pass - @property - def gameName(self) -> str: - pass - @gameName.setter - def gameName(self, arg0: str): - pass - @property - def modID(self) -> int: - pass - @modID.setter - def modID(self, arg0: int): - pass - @property - def modName(self) -> str: - pass - @modName.setter - def modName(self, arg0: str): - pass - @property - def name(self) -> str: - pass - @name.setter - def name(self, arg0: str): - pass - @property - def newestVersion(self) -> VersionInfo: - pass - @newestVersion.setter - def newestVersion(self, arg0: VersionInfo): - pass - @property - def repository(self) -> str: - pass - @repository.setter - def repository(self, arg0: str): - pass - @property - def uri(self) -> str: - pass - @uri.setter - def uri(self, arg0: str): - pass - @property - def userData(self) -> MoVariant: - pass - @userData.setter - def userData(self, arg0: MoVariant): - pass - @property - def version(self) -> VersionInfo: - pass - @version.setter - def version(self, arg0: VersionInfo): - pass - @overload - def __init__(self): - pass - @overload - def __init__(self, arg1: "ModRepositoryFileInfo"): - pass - @overload - def __init__(self, arg1: str = None, arg2: int = None, arg3: int = None): - pass - @staticmethod - def createFromJson(arg0: str) -> "ModRepositoryFileInfo": - pass - def toString(self) -> str: - pass - -class PluginSetting: - def __init__(self, arg1: str, arg2: str, arg3: MoVariant): - pass - -class SaveGameInfo: - def __init__(self): - pass - def getMissingAssets(self, arg1: str) -> Dict[str, List[str]]: - pass - def getSaveGameInfo(self, arg1: str) -> "ISaveGame": - pass - def getSaveGameWidget( - self, arg1: PyQt5.QtWidgets.QWidget - ) -> InterfaceNotImplemented: - pass - def hasScriptExtenderSave(self, arg1: str) -> bool: - pass - -class ScriptExtender: - def __init__(self): - pass - def BinaryName(self) -> str: - pass - def PluginPath(self) -> str: - pass - def getArch(self) -> int: - pass - def getExtenderVersion(self) -> str: - pass - def isInstalled(self) -> bool: - pass - def loaderName(self) -> str: - pass - def loaderPath(self) -> str: - pass - def saveGameAttachmentExtensions(self) -> List[str]: - pass - -class UnmanagedMods: - def __init__(self): - pass - def displayName(self, arg1: str) -> str: - pass - def mods(self, arg1: bool) -> List[str]: - pass - def referenceFile(self, arg1: str) -> PyQt5.QtCore.QFileInfo: - pass - def secondaryFiles(self, arg1: str) -> List[str]: - pass - -class VersionInfo: - @overload - def __init__(self): - pass - @overload - def __init__(self, arg1: str): - pass - @overload - def __init__(self, arg1: str, arg2: "VersionScheme"): - pass - @overload - def __init__(self, arg1: int, arg2: int, arg3: int): - pass - @overload - def __init__(self, arg1: int, arg2: int, arg3: int, arg4: "ReleaseType"): - pass - @overload - def __init__(self, arg1: int, arg2: int, arg3: int, arg4: int): - pass - @overload - def __init__(self, arg1: int, arg2: int, arg3: int, arg4: int, arg5: "ReleaseType"): - pass - @overload - def __eq__(self, arg1: "VersionInfo") -> bool: - pass - @overload - def __eq__(self, arg1: object) -> bool: - pass - def __ge__(self, arg1: "VersionInfo") -> bool: - pass - def __gt__(self, arg1: "VersionInfo") -> bool: - pass - def __le__(self, arg1: "VersionInfo") -> bool: - pass - def __lt__(self, arg1: "VersionInfo") -> bool: - pass - @overload - def __ne__(self, arg1: "VersionInfo") -> bool: - pass - @overload - def __ne__(self, arg1: object) -> bool: - pass - def canonicalString(self) -> str: - pass - def clear(self): - pass - def displayString(self, arg1: int) -> str: - pass - def isValid(self) -> bool: - pass - def parse(self, arg1: str, arg2: "VersionScheme", arg3: bool): - pass - def scheme(self) -> "VersionScheme": - pass diff --git a/stubs/2.3.0/mobase.pyi b/stubs/2.3.0/mobase.pyi deleted file mode 100644 index b9c50a4..0000000 --- a/stubs/2.3.0/mobase.pyi +++ /dev/null @@ -1,3483 +0,0 @@ -__version__ = "2.3.0" - -import abc -from enum import Enum -from typing import ( - Dict, - Iterator, - List, - Tuple, - Union, - Any, - Optional, - Callable, - overload, - TypeVar, - Type, -) -import PyQt5.QtCore -import PyQt5.QtGui -import PyQt5.QtWidgets - -MoVariant = Union[None, bool, int, str, List[Any], Dict[str, Any]] -GameFeatureType = TypeVar("GameFeatureType") - -class InterfaceNotImplemented: ... - -def getFileVersion(filepath: str) -> str: - """ - Retrieve the file version of the given executable. - - Args: - filepath: Absolute path to the executable. - - Returns: - The file version, or an empty string if the file version could not be retrieved. - """ - ... - -def getIconForExecutable(executable: str) -> PyQt5.QtGui.QIcon: - """ - Retrieve the icon of an executable. Currently this always extracts the biggest icon. - - Args: - executable: Absolute path to the executable. - - Returns: - The icon for this executable, if any. - """ - ... - -def getProductVersion(executable: str) -> str: - """ - Retrieve the product version of the given executable. - - Args: - executable: Absolute path to the executable. - - Returns: - The product version, or an empty string if the product version could not be retrieved. - """ - ... - -class GuessQuality(Enum): - """ - Describes how good the code considers a guess (i.e. for a mod name) this is used to - determine if a name from another source should overwrite or not. - """ - - INVALID = ... - FALLBACK = ... - GOOD = ... - META = ... - PRESET = ... - USER = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class InstallResult(Enum): - SUCCESS = ... - FAILED = ... - CANCELED = ... - MANUAL_REQUESTED = ... - NOT_ATTEMPTED = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class LoadOrderMechanism(Enum): - FILE_TIME = ... - PLUGINS_TXT = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class ModState(Enum): - EXISTS = ... - ACTIVE = ... - ESSENTIAL = ... - EMPTY = ... - ENDORSED = ... - VALID = ... - ALTERNATE = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class PluginState(Enum): - MISSING = ... - INACTIVE = ... - ACTIVE = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class ProfileSetting(Enum): - MODS = ... - CONFIGURATION = ... - SAVEGAMES = ... - PREFER_DEFAULTS = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class ReleaseType(Enum): - PRE_ALPHA = ... - ALPHA = ... - BETA = ... - CANDIDATE = ... - FINAL = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class SortMechanism(Enum): - NONE = ... - MLOX = ... - BOSS = ... - LOOT = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class VersionScheme(Enum): - DISCOVER = ... - REGULAR = ... - DECIMAL_MARK = ... - NUMBERS_AND_LETTERS = ... - DATE = ... - LITERAL = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class BSAInvalidation(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def activate(self, profile: "IProfile"): ... - @abc.abstractmethod - def deactivate(self, profile: "IProfile"): ... - @abc.abstractmethod - def isInvalidationBSA(self, name: str) -> bool: ... - -class DataArchives(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def addArchive(self, profile: "IProfile", index: int, name: str): - """ - Add an archive to the archive list. - - Args: - profile: Profile to add the archive to. - index: Index to insert before. Use 0 for the beginning of the list or INT_MAX for the end of the list). - name: Name of the archive to add. - """ - ... - @abc.abstractmethod - def archives(self, profile: "IProfile") -> List[str]: - """ - Retrieve the list of archives in the given profile. - - Args: - profile: Profile to retrieve archives from. - - Returns: - The list of archives in the given profile. - """ - ... - @abc.abstractmethod - def removeArchive(self, profile: "IProfile", name: str): - """ - Remove the given archive from the given profile. - - Args: - profile: Profile to remove the archive from. - name: Name of the archive to remove. - """ - ... - @abc.abstractmethod - def vanillaArchives(self) -> List[str]: - """ - Retrieve the list of vanilla archives. - - Vanilla archives are archive files that are shipped with the original - game. - - Returns: - The list of vanilla archives. - """ - ... - -class ExecutableForcedLoadSetting: - def __init__(self, process: str, library: str): ... - def enabled(self) -> bool: ... - def forced(self) -> bool: ... - def library(self) -> str: ... - def process(self) -> str: ... - def withEnabled(self, enabled: bool) -> "ExecutableForcedLoadSetting": ... - def withForced(self, forced: bool) -> "ExecutableForcedLoadSetting": ... - -class ExecutableInfo: - def __init__(self, title: str, binary: PyQt5.QtCore.QFileInfo): ... - def arguments(self) -> List[str]: ... - def asCustom(self) -> "ExecutableInfo": ... - def binary(self) -> PyQt5.QtCore.QFileInfo: ... - def isCustom(self) -> bool: ... - def isValid(self) -> bool: ... - def steamAppID(self) -> str: ... - def title(self) -> str: ... - def withArgument(self, argument: str) -> "ExecutableInfo": ... - def withSteamAppId(self, app_id: str) -> "ExecutableInfo": ... - def withWorkingDirectory( - self, directory: PyQt5.QtCore.QDir - ) -> "ExecutableInfo": ... - def workingDirectory(self) -> PyQt5.QtCore.QDir: ... - -class FileInfo: - """ - Information about a virtualised file - """ - - @property - def archive(self) -> str: ... - @archive.setter - def archive(self, arg0: str): ... - @property - def filePath(self) -> str: ... - @filePath.setter - def filePath(self, arg0: str): ... - @property - def origins(self) -> List[str]: ... - @origins.setter - def origins(self, arg0: List[str]): ... - def __init__(self): - """ - Creates an uninitialized FileInfo. - """ - ... - -class FileTreeEntry: - """ - Represent an entry in a file tree, either a file or a directory. This class - inherited by IFileTree so that operations on entry are the same for a file or - a directory. - - This class provides convenience methods to query information on the file, like its - name or the its last modification time. It also provides a convenience astree() method - that can be used to retrieve the tree corresponding to its entry in case the entry - represent a directory. - """ - - class FileTypes(Enum): - """ - Enumeration of the different file type or combinations. - """ - - DIRECTORY = ... - FILE = ... - FILE_OR_DIRECTORY = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - DIRECTORY: "FileTreeEntry.FileTypes" = ... - FILE: "FileTreeEntry.FileTypes" = ... - FILE_OR_DIRECTORY: "FileTreeEntry.FileTypes" = ... - @overload - def __eq__(self, arg2: str) -> bool: ... - @overload - def __eq__(self, arg2: "FileTreeEntry") -> bool: ... - @overload - def __eq__(self, other: object) -> bool: ... - def __repr__(self) -> str: ... - def detach(self) -> bool: - """ - Detach this entry from its parent tree. - - Returns: - True if the entry was removed correctly, False otherwize. - """ - ... - def fileType(self) -> "FileTreeEntry.FileTypes": - """ - Returns: - The filetype of this entry. - """ - ... - @overload - def hasSuffix(self, suffixes: List[str]) -> bool: - """ - Check if this entry has one of the given suffixes. - - Args: - suffixes: Suffixes to check. - - Returns: - True if this entry is a file and has one of the given suffix. - """ - ... - @overload - def hasSuffix(self, suffix: str) -> bool: - """ - Check if this entry has the given suffix. - - Args: - suffix: Suffix to check. - - Returns: - True if this entry is a file and has the given suffix. - """ - ... - def isDir(self) -> bool: - """ - Returns: - True if this entry is a directory, False otherwise. - """ - ... - def isFile(self) -> bool: - """ - Returns: - True if this entry is a file, False otherwise. - """ - ... - def moveTo(self, tree: "IFileTree") -> bool: - """ - Move this entry to the given tree. - - Args: - tree: The tree to move this entry to. - - Returns: - True if the entry was moved correctly, False otherwize. - """ - ... - def name(self) -> str: - """ - Returns: - The name of this entry. - """ - ... - def parent(self) -> Optional["IFileTree"]: - """ - Returns: - The parent tree containing this entry, or a `None` if this entry is the root - or the parent tree is unreachable. - """ - ... - def path(self, sep: str = "\\") -> str: - """ - Retrieve the path from this entry up to the root of the tree. - - This method propagate up the tree so is not constant complexity as - the full path is never stored. - - Args: - sep: The type of separator to use to create the path. - - Returns: - The path from this entry to the root, including the name of this entry. - """ - ... - def pathFrom(self, tree: "IFileTree", sep: str = "\\") -> str: - """ - Retrieve the path from the given tree to this entry. - - Args: - tree: The tree to reach, must be a parent of this entry. - sep: The type of separator to use to create the path. - - Returns: - The path from the given tree to this entry, including the name of this entry, or - an empty string if the given tree is not a parent of this entry. - """ - ... - def suffix(self) -> str: - """ - Retrieve the "last" extension of this entry. - - The "last" extension is everything after the last dot in the file name. - - Returns: - The last extension of this entry, or an empty string if the file has no extension - or is directory. - """ - ... - -class GamePlugins(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def getLoadOrder(self) -> List[str]: ... - @abc.abstractmethod - def lightPluginsAreSupported(self) -> bool: - """ - Returns: - True if light plugins are supported, False otherwise. - """ - ... - @abc.abstractmethod - def readPluginLists(self, plugin_list: "IPluginList"): ... - @abc.abstractmethod - def writePluginLists(self, plugin_list: "IPluginList"): ... - -class GuessedString: - """ - Represents a string that may be set from different places. Each time the value is - changed a "quality" is specified to say how probable it is the value is the best choice. - Only the best choice should be used in the end but alternatives can be queried. This - class also allows a filter to be set. If a "guess" doesn't pass the filter, it is ignored. - """ - - @overload - def __init__(self): - """ - Creates a GuessedString with no associated value. - """ - ... - @overload - def __init__(self, value: str, quality: "GuessQuality"): - """ - Creates a GuessedString with the given value and quality. - - Args: - value: Initial value of the GuessedString. - quality: Quality of the initial value. - """ - ... - def __str__(self) -> str: ... - @overload - def reset(self) -> "GuessedString": - """ - Reset this GuessedString to an invalid state. - - Returns: - This GuessedString object. - """ - ... - @overload - def reset(self, value: str, quality: "GuessQuality") -> "GuessedString": - """ - Reset this GuessedString object with the given value and quality, only - if the given quality is better than the current one. - - Args: - value: New value for this GuessedString. - quality: Quality of the new value. - - Returns: - This GuessedString object. - """ - ... - @overload - def reset(self, other: "GuessedString") -> "GuessedString": - """ - Reset this GuessedString object by copying the given one, only - if the given one has better quality. - - Args: - other: The GuessedString to copy. - - Returns: - This GuessedString object. - """ - ... - def setFilter(self, filter: Callable[[str], Union[str, bool]]): - """ - Set the filter for this GuessedString. - - The filter is applied on every `update()` and can reject the new value - altogether or modify it (by returning a new value). - - Args: - filter: The new filter. - """ - ... - @overload - def update(self, value: str) -> "GuessedString": - """ - Update this GuessedString by adding the given value to the list of variants - and setting the actual value without changing the current quality of this - GuessedString. - - The GuessedString is only updated if the given value passes the filter. - - Args: - value: The new value for this string. - - Returns: - This GuessedString object. - """ - ... - @overload - def update(self, value: str, quality: "GuessQuality") -> "GuessedString": - """ - Update this GuessedString by adding a new variants with the given quality. - - If the specified quality is better than the current one, the actual value of - the GuessedString is also updated. - - The GuessedString is only updated if the given value passes the filter. - - Args: - value: The new variant to add. - quality: The quality of the variant. - - Returns: - This GuessedString object. - """ - ... - def variants(self) -> List[str]: - """ - Returns: - The list of variants for this GuessedString. - """ - ... - -class IDownloadManager(PyQt5.QtCore.QObject): - downloadComplete: PyQt5.QtCore.pyqtSignal = ... - downloadPaused: PyQt5.QtCore.pyqtSignal = ... - downloadFailed: PyQt5.QtCore.pyqtSignal = ... - downloadRemoved: PyQt5.QtCore.pyqtSignal = ... - def _object(self) -> PyQt5.QtCore.QObject: - """ - Returns: - The underlying `QObject` for the manager. - """ - ... - def downloadPath(self, id: int) -> str: - """ - Retrieve the (absolute) path of the specified download. - - Args: - id: ID of the download. - - Returns: - The absolute path to the file corresponding to the given download. This file - may not exist yet if the download is incomplete. - """ - ... - def startDownloadNexusFile(self, mod_id: int, file_id: int) -> int: - """ - Download a file from www.nexusmods.com/. is always the game - currently being managed. - - Args: - mod_id: ID of the mod to download the file from. - file_id: ID of the file to download. - - Returns: - An ID identifying the download. - """ - ... - def startDownloadURLs(self, urls: List[str]) -> int: - """ - Download a file by url. - - The list can contain alternative URLs to allow the download manager to switch - in case of download problems - - Args: - urls: List of urls to download from. - - Returns: - An ID identifying the download. - """ - ... - -class IFileTree(FileTreeEntry): - """ - Interface to classes that provides way to visualize and alter file trees. The tree - may not correspond to an actual file tree on the disk (e.g., inside an archive, - from a QTree Widget, ...). - - Read-only operations on the tree are thread-safe, even when the tree has not been populated - yet. - - In order to prevent wrong usage of the tree, implementing classes may throw - UnsupportedOperationException if an operation is not supported. By default, all operations - are supported, but some may not make sense in many situations. - - The goal of this is not reflect the change made to a IFileTree to the disk, but child - classes may override relevant methods to do so. - - The tree is built upon FileTreeEntry. A given tree holds shared pointers to its entries - while each entry holds a weak pointer to its parent, this means that the descending link - are strong (shared pointers) but the uplink are weaks. - - Accessing the parent is always done by locking the weak pointer so that returned pointer - or either null or valid. This structure implies that as long as the initial root lives, - entry should not be destroyed, unless the entry are detached from the root and no shared - pointers are kept. - - However, it is not guarantee that one can go up the tree from a single node entry. If the - root node is destroyed, it will not be possible to go up the tree, even if we still have - a valid shared pointer. - """ - - class InsertPolicy(Enum): - FAIL_IF_EXISTS = ... - REPLACE = ... - MERGE = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - class WalkReturn(Enum): - """ - Enumeration that can be returned by the callback for the `walk()` method to stop the - walking operation early. - """ - - CONTINUE = ... - STOP = ... - SKIP = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - CONTINUE: "IFileTree.WalkReturn" = ... - FAIL_IF_EXISTS: "IFileTree.InsertPolicy" = ... - MERGE: "IFileTree.InsertPolicy" = ... - REPLACE: "IFileTree.InsertPolicy" = ... - SKIP: "IFileTree.WalkReturn" = ... - STOP: "IFileTree.WalkReturn" = ... - def __bool__(self) -> bool: - """ - Returns: - True if this tree is not empty, False otherwise. - """ - ... - def __getitem__(self, index: int) -> "FileTreeEntry": - """ - Retrieve the entry at the given index in this tree. - - Args: - index: Index of the entry to retrieve, must be less than the size. - - Returns: - The entry at the given index. - - Raises: - IndexError: If the given index is not in range for this tree. - """ - ... - def __iter__(self) -> Iterator[FileTreeEntry]: - """ - Retrieves an iterator for entries directly under this tree. - - This method does not recurse into subtrees, see `walk()` for this. - - Returns: - An iterator object that can be used to iterate over entries in this tree. - """ - ... - def __len__(self) -> int: - """ - Returns: - The number of entries directly under this tree. - """ - ... - def __repr__(self) -> str: ... - def addDirectory(self, path: str) -> "IFileTree": - """ - Create a new directory tree under this tree. - - This method will create missing folders in the given path and will - not fail if the directory already exists but will fail if the given - path contains "." or "..". - This method invalidates iterators to this tree and all the subtrees - present in the given path. - - Args: - path: Path to the directory to create. - - Returns: - An IFileTree corresponding to the created directory. - - Raises: - RuntimeError: If the directory could not be created. - """ - ... - def addFile(self, path: str, replace_if_exists: bool = False) -> "FileTreeEntry": - """ - Create a new file directly under this tree. - - This method will fail if the file already exists and `replace_if_exists` is `False`. - This method invalidates iterators to this tree and all the subtrees present in the - given path. - - Args: - path: Path to the file to create. - replace_if_exists: If True and an entry already exists at the given location, it will be replaced by a new entry. This will replace both files and directories. - - Returns: - A FileTreeEntry corresponding to the created file. - - Raises: - RuntimeError: If the file could not be created. - """ - ... - def clear(self) -> bool: - """ - Delete (detach) all the entries from this tree. - - This method will go through the entries in this tree and stop at the first - entry that cannot be deleted, this means that the tree can be partially cleared. - - Returns: - True if all entries have been detached, False otherwise. - """ - ... - def copy( - self, - entry: "FileTreeEntry", - path: str = "", - policy: "IFileTree.InsertPolicy" = InsertPolicy.FAIL_IF_EXISTS, - ) -> "FileTreeEntry": - """ - Move the given entry to the given path under this tree. - - The entry must not be a parent tree of this tree. This method can also be used - to rename entries. - - If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry - at the same location already exists. If the policy is REPLACE, an existing - entry will be replaced. If MERGE, the entry will be merged with the existing - one (if the entry is a file, and a file exists, the file will be replaced). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - - Args: - entry: Entry to copy. - path: The path to copy the entry to. If the path ends with / or \\, the entry will be copied in the corresponding directory instead of replacing it. If the - given path is empty (`""`), the entry is copied directly under this tree. - policy: Policy to use to resolve conflicts. - - Returns: - The new entry (copy of the specified entry). - - Raises: - RuntimeError: If the entry could not be copied. - """ - ... - def createOrphanTree(self, name: str = "") -> "IFileTree": - """ - Create a new orphan empty tree. - - Args: - name: Name of the tree. - - Returns: - A new tree without any parent. - """ - ... - def exists( - self, - path: str, - type: "FileTreeEntry.FileTypes" = FileTreeEntry.FileTypes.FILE_OR_DIRECTORY, - ) -> bool: - """ - Check if the given entry exists. - - Args: - path: Path to the entry, separated by / or \\. - type: The type of the entry to check. - - Returns: - True if the entry was found, False otherwise. - """ - ... - def find( - self, - path: str, - type: "FileTreeEntry.FileTypes" = FileTreeEntry.FileTypes.FILE_OR_DIRECTORY, - ) -> Optional[Union["IFileTree", "FileTreeEntry"]]: - """ - Retrieve the given entry. - - If no entry exists at the given path, or if the entry is not of the right - type, `None` is returned. - - Args: - path: Path to the entry, separated by / or \\. - type: The type of the entry to check. - - Returns: - The entry at the given location, or `None` if the entry was not found or - was not of the correct type. - """ - ... - def insert( - self, - entry: "FileTreeEntry", - policy: "IFileTree.InsertPolicy" = InsertPolicy.FAIL_IF_EXISTS, - ) -> bool: - """ - Insert the given entry in this tree, removing it from its - previouis parent. - - The entry must not be this tree or a parent entry of this tree. - - - If the insert policy if `FAIL_IF_EXISTS`, the call will fail if an entry - with the same name already exists. - - If the policy is `REPLACE`, an existing entry will be replaced by the given entry. - - If the policy is `MERGE`: - - - If there is no entry with the same name, the new entry is inserted. - - If there is an entry with the same name: - - - If both entries are files, the old file is replaced by the given entry. - - If both entries are directories, a merge is performed as if using merge(). - - Otherwize the insertion fails (two entries with different types). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - - Args: - entry: Entry to insert. - policy: Policy to use to resolve conflicts. - - Returns: - True if the entry was insert, False otherwise. - """ - ... - def merge( - self, other: "IFileTree", overwrites: bool = False - ) -> Union[Dict["FileTreeEntry", "FileTreeEntry"], int]: - """ - Merge the given tree with this tree, i.e., insert all entries - of the given tree into this tree. - - The tree must not be this tree or a parent entry of this tree. Files present in both tree - will be replaced by files in the given tree. After a merge, the source tree will be - empty but still attached to its parent. - - If `overwrites` is `True`, a map from overriden files to new files will be returned. - - Note that the merge process makes no distinction between files and directories - when merging: if a directory is present in this tree and a file from source - is in conflict with it, the tree will be removed and the file inserted; if a file - is in this tree and a directory from source is in conflict with it, the file will - be replaced with the directory. - - This method invalidates iterators to this tree, all the subtrees under this tree - present in the given path, and all the subtrees of the given source. - - Args: - other: Tree to merge. - overwrites: If True, a mapping from overriden files to new files will be returned. - - Returns: - If `overwrites` is True, a mapping from overriden files to new files, otherwise - the number of overwritten entries. - - Raises: - RuntimeError: If the merge failed. - """ - ... - def move( - self, - entry: "FileTreeEntry", - path: str, - policy: "IFileTree.InsertPolicy" = InsertPolicy.FAIL_IF_EXISTS, - ) -> bool: - """ - Move the given entry to the given path under this tree. - - The entry must not be a parent tree of this tree. This method can also be used - to rename entries. - - If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry - at the same location already exists. If the policy is REPLACE, an existing - entry will be replaced. If MERGE, the entry will be merged with the existing - one (if the entry is a file, and a file exists, the file will be replaced). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - - Args: - entry: Entry to move. - path: The path to move the entry to. If the path ends with / or \\, the entry will be inserted in the corresponding directory instead of replacing it. If the - given path is empty (`""`), this is equivalent to `insert()`. - policy: Policy to use to resolve conflicts. - - Returns: - True if the entry was moved correctly, False otherwise. - """ - ... - def pathTo(self, entry: "FileTreeEntry", sep: str = "\\") -> str: - """ - Retrieve the path from this tree to the given entry. - - Args: - entry: The entry to reach, must be in this tree. - sep: The type of separator to use to create the path. - - Returns: - The path from this tree to the given entry, including the name of the entry, or - an empty string if the given entry was not found under this tree. - """ - ... - @overload - def remove(self, name: str) -> bool: - """ - Delete the entry with the given name. - - This method does not recurse into subtrees, so the entry should be - accessible directly from this tree. - - Args: - name: Name of the entry to delete. - - Returns: - True if the entry was deleted, False otherwise. - """ - ... - @overload - def remove(self, entry: "FileTreeEntry") -> bool: - """ - Delete the given entry. - - Args: - entry: Entry to delete. The entry must belongs to this tree (and not to a subtree). - - Returns: - True if the entry was deleted, False otherwise. - """ - ... - def removeAll(self, names: List[str]) -> int: - """ - Delete the entries with the given names from the tree. - - This method does not recurse into subtrees, so only entries accessible - directly from this tree will be removed. This method invalidates iterators. - - Args: - names: Names of the entries to delete. - - Returns: - The number of deleted entry. - """ - ... - def removeIf(self, filter: Callable[["FileTreeEntry"], bool]) -> int: - """ - Delete entries matching the given predicate from the tree. - - This method does not recurse into subtrees, so only entries accessible - directly from this tree will be removed. This method invalidates iterators. - - Args: - filter: Predicate that should return true for entries to delete. - - Returns: - The number of deleted entry. - """ - ... - def walk( - self, - callback: Callable[[str, "FileTreeEntry"], "IFileTree.WalkReturn"], - sep: str = "\\", - ): - """ - Walk this tree, calling the given function for each entry in it. - - The given callback will be called with two parameters: the path from this tree to the given entry - (with a trailing separator, not including the entry name), and the actual entry. The method returns - a `WalkReturn` object to indicates what to do. - - Args: - callback: Method to call for each entry in the tree. - sep: Type of separator to use to construct the path. - """ - ... - -class IInstallationManager: - def createFile(self, entry: "FileTreeEntry") -> str: - """ - Create a new file on the disk corresponding to the given entry. - - This method can be used by installer that needs to create files that are not in the original - archive. At the end of the installation, if there are entries in the final tree that were used - to create files, the corresponding files will be moved to the mod folder. - - Temporary files corresponding to created files are automatically cleaned up at the end of - the installation. - - Args: - entry: The entry for which a temporary file should be created. - - Returns: - The path to the created file, or an empty string if the file could not be created. - """ - ... - def extractFile(self, entry: "FileTreeEntry", silent: bool = False) -> str: - """ - Extract the specified file from the currently opened archive to a temporary - location. - - This method cannot be used to extract directory. - - The call will fail with an exception if no archive is open (plugins deriving from - IPluginInstallerSimple can rely on that, custom installers should not). The temporary - file is automatically cleaned up after the installation. This call can be very slow - if the archive is large and "solid". - - Args: - entry: Entry corresponding to the file to extract. - silent: If true, the dialog showing extraction progress will not be shown. - - Returns: - The absolute path to the temporary file, or an empty string if the file was not extracted. - """ - ... - def extractFiles( - self, entries: List["FileTreeEntry"], silent: bool = False - ) -> List[str]: - """ - Extract the specified files from the currently opened archive to a temporary - location. - - This method cannot be used to extract directories. - - The call will fail with an exception if no archive is open (plugins deriving from - IPluginInstallerSimple can rely on that, custom installers should not). The temporary - files are automatically cleaned up after the installation. This call can be very slow - if the archive is large and "solid". - - Args: - entries: Entries corresponding to the files to extract. - silent: If true, the dialog showing extraction progress will not be shown. - - Returns: - A list containing absolute paths to the temporary files. - """ - ... - def getSupportedExtensions(self) -> List[str]: - """ - Returns: - The extensions of archives supported by this installation manager. - """ - ... - def installArchive( - self, mod_name: "GuessedString", archive: str, mod_id: int - ) -> "InstallResult": - """ - Install the given archive. - - Args: - mod_name: Suggested name of the mod. - archive: Path to the archive to install. - mod_id: ID of the mod, if available. - - Returns: - The result of the installation. - """ - ... - def setURL(self, url: str): - """ - Set the url associated with the mod being installed. - - Args: - url: Url to set. - """ - ... - -class IModInterface: - def absolutePath(self) -> str: - """ - Returns: - Absolute path to the mod to be used in file system operations. - """ - ... - def addCategory(self, name: str): - """ - Assign a category to the mod. If the named category does not exist it is created. - - Args: - name: Name of the new category to assign. - """ - ... - def addNexusCategory(self, category_id: int): - """ - Set the category id from a nexus category id. Conversion to MO ID happens internally. - - If a mapping is not possible, the category is set to the default value. - - Args: - category_id: The Nexus category ID. - """ - ... - def categories(self) -> List[str]: - """ - Returns: - The list of categories assigned to this mod. - """ - ... - def name(self) -> str: - """ - Returns: - The name of this mod. - """ - ... - def remove(self) -> bool: - """ - Delete the mod from the disc. - - This does not update the global ModInfo structure or indices. - - Returns: - True if the mod was deleted, False otherwise. - """ - ... - def removeCategory(self, name: str) -> bool: - """ - Unassign a category from this mod. - - Args: - name: Name of the category to remove. - - Returns: - True if the category was removed, False otherwise (e.g. if no such category - was assigned). - """ - ... - def setGameName(self, name: str): - """ - Set the source game of this mod. - - Args: - name: The new source game short name of this mod. - """ - ... - def setIsEndorsed(self, endorsed: bool): - """ - Set endorsement state of the mod. - - Args: - endorsed: New endorsement state of this mod. - """ - ... - def setName(self, name: str) -> bool: - """ - Set the name of this mod. - - This will also update the name of the directory that contains this mod - - Args: - name: New name for this mod. - - Returns: - True if the name was changed, False if an error occured (e.g. if the name is not a valid - directory name). - """ - ... - def setNewestVersion(self, version: "VersionInfo"): - """ - Set the latest known version of this mod. - - Args: - version: The latest known version of this mod. - """ - ... - def setNexusID(self, nexus_id: int): - """ - Set the Nexus ID of this mod. - - Args: - nexus_id: Thew new Nexus ID of this mod. - """ - ... - def setVersion(self, version: "VersionInfo"): - """ - Set the version of this mod. - - Args: - version: The new version of this mod. - """ - ... - -class IModList: - """ - Interface to the mod-list. - - All api functions in this interface work need the internal name of a mod to find a - mod. For regular mods (mods the user installed) the display name (as shown to the user) - and internal name are identical. For other mods (non-MO mods) there is currently no way - to translate from display name to internal name because the display name might not me un-ambiguous. - """ - - def allMods(self) -> List[str]: - """ - Returns: - A list containing the internal names of all installed mods. - """ - ... - def displayName(self, name: str) -> str: - """ - Retrieve the display name of a mod from its internal name. - - If you received an internal name from the API (e.g. `IPluginList.origin`) then you should use - that name to identify the mod in all other api calls but use this function to retrieve the name - to show to the user. - - Args: - name: Internal name of the mod. - - Returns: - The display name of the given mod. - """ - ... - def onModMoved(self, callback: Callable[[str, int, int], None]) -> bool: - """ - Install a handler to be called when a mod is moved. - - Args: - callback: The function to call when a mod is moved. The first argument is the internal name of the mod, the second argument the old priority and the third argument the new priority. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onModStateChanged(self, callback: Callable[[str, int], None]) -> bool: - """ - Install a handler to be called when a mod state changes (enabled/disabled, endorsed, ...). - - Args: - callback: The function to call when the state of a mod changes. The first argument is the internal mod name, and the second one the new state of the mod. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def priority(self, name: str) -> int: - """ - Retrieve the priority of a mod. - - Args: - name: Internal name of the mod. - - Returns: - The priority of the given mod. - """ - ... - def setActive(self, name: str, active: bool) -> bool: - """ - Enable or disable a mod. - - Calling this will cause MO to re-evaluate its virtual file system so this is - a fairly expensive call. - - Args: - name: Internal name of the mod to enable or disable. - active: True to enable the mod, False to disable it. - - Returns: - True on success, False otherwise. - """ - ... - def setPriority(self, name: str, priority: int) -> bool: - """ - Change the priority of a mod. - - `priority` is the new priority after the move. Keep in mind that the mod disappears from its - old location and all mods with higher priority than the moved mod decrease in priority by one. - - Args: - name: Internal name of the mod. - priority: The new priority of the mod. - - Returns: - True if the priority was changed, False otherwise (if the name or priority were invalid). - """ - ... - def state(self, name: str) -> int: - """ - Retrieve the state of a mod. - - Args: - name: Internal name of the mod. - - Returns: - The state of the given mod. - """ - ... - -class IModRepositoryBridge(PyQt5.QtCore.QObject): - descriptionAvailable: PyQt5.QtCore.pyqtSignal = ... - filesAvailable: PyQt5.QtCore.pyqtSignal = ... - fileInfoAvailable: PyQt5.QtCore.pyqtSignal = ... - downloadURLsAvailable: PyQt5.QtCore.pyqtSignal = ... - endorsementsAvailable: PyQt5.QtCore.pyqtSignal = ... - endorsementToggled: PyQt5.QtCore.pyqtSignal = ... - trackedModsAvailable: PyQt5.QtCore.pyqtSignal = ... - trackingToggled: PyQt5.QtCore.pyqtSignal = ... - requestFailed: PyQt5.QtCore.pyqtSignal = ... - def _object(self) -> PyQt5.QtCore.QObject: - """ - Returns: - The underlying `QObject` for the bridge. - """ - ... - def requestDescription(self, game_name: str, mod_id: int, user_data: MoVariant): - """ - Request description of a mod. - - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - user_data: User data to be returned with the result. - """ - ... - def requestDownloadURL( - self, game_name: str, mod_id: int, file_id: int, user_data: MoVariant - ): - """ - Request download URL for mod file.0 - - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - file_id: ID of the file for which a URL should be returned. - user_data: User data to be returned with the result. - """ - ... - def requestFileInfo( - self, game_name: str, mod_id: int, file_id: int, user_data: MoVariant - ): - """ - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - file_id: ID of the file for which information is requested. - user_data: User data to be returned with the result. - """ - ... - def requestFiles(self, game_name: str, mod_id: int, user_data: MoVariant): - """ - Request the list of files belonging to a mod. - - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - user_data: User data to be returned with the result. - """ - ... - def requestToggleEndorsement( - self, - game_name: str, - mod_id: int, - mod_version: str, - endorse: bool, - user_data: MoVariant, - ): - """ - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - mod_version: Version of the mod. - endorse: - user_data: User data to be returned with the result. - """ - ... - -class IOrganizer: - """ - Interface to class that provides information about the running session - of Mod Organizer to be used by plugins. - """ - - def appVersion(self) -> "VersionInfo": - """ - Returns: - The running version of Mod Organizer. - """ - ... - def basePath(self) -> str: - """ - Returns: - The absolute path to the base directory of Mod Organizer. - """ - ... - def createMod(self, name: "GuessedString") -> "IModInterface": - """ - Create a new mod with the specified name. - - If a mod with the same name already exists, the user will be queried. If the user chooses - to merge or replace, the call will succeed, otheriwse the call will fail. - - Args: - name: Name of the mod to create. - - Returns: - An interface to the newly created mod that can be used to modify it, or `None` if the mod - could not be created. - """ - ... - def createNexusBridge(self) -> "IModRepositoryBridge": - """ - Create a new Nexus interface. - - Returns: - The newly created Nexus interface. - """ - ... - def downloadManager(self) -> "IDownloadManager": - """ - Returns: - The interface to the download manager. - """ - ... - def downloadsPath(self) -> str: - """ - Returns: - The absolute path to the download directory. - """ - ... - def findFileInfos( - self, path: str, filter: Callable[["FileInfo"], bool] - ) -> List["FileInfo"]: - """ - Find files in the virtual directory matching the specified filter. - - Args: - path: The path to search in (relative to the 'data' folder). - filter: The function to use to filter files. Should return True for the files to keep. - - Returns: - The list of `QFileInfo` corresponding to the matching files. - """ - ... - @overload - def findFiles(self, path: str, filter: Callable[[str], bool]) -> List[str]: - """ - Find files in the given folder that matches the given filter. - - Args: - path: The path to search in (relative to the 'data' folder). - filter: The function to use to filter files. Should return True for the files to keep. - - Returns: - The list of matching files. - """ - ... - @overload - def findFiles(self, path: str, patterns: List[str]) -> List[str]: - """ - Find files in the given folder that matches one of the given glob patterns. - - Args: - path: The path to search in (relative to the 'data' folder). - patterns: List of glob patterns to match against. - - Returns: - The list of matching files. - """ - ... - @overload - def findFiles(self, path: str, pattern: str) -> List[str]: - """ - Find files in the given folder that matches the given glob pattern. - - Args: - path: The path to search in (relative to the 'data' folder). - pattern: The glob pattern to use to filter files. - - Returns: - The list of matching files. - """ - ... - def getFileOrigins(self, filename: str) -> List[str]: - """ - Retrieve the file origins for the speicified file. - - The origins are listed with their internal name. The internal name of a mod can differ - from the display name for disambiguation. - - Args: - filename: Path to the file to retrieve origins for (relative to the 'data' folder). - - Returns: - The list of origins that contain the specified file, sorted by their priority. - """ - ... - def getGame(self, name: str) -> "IPluginGame": - """ - Retrieve the game plugin matching the given name. - - Args: - name: Name of the game (short name). - - Returns: - The plugin for the given game, or `None` if none was found. - """ - ... - def getMod(self, name: str) -> "IModInterface": - """ - Retrieve an interface to a mod using its name. - - Args: - name: Name of the mod to retrieve. - - Returns: - An interface to the given mod, or `None` if there is no mod with this name - """ - ... - def installMod(self, filename: str, name_suggestion: str = "") -> "IModInterface": - """ - Install a mod archive at the specified location. - - Args: - filename: Absolute filepath to the archive to install. - name_suggestion: Suggested name for this mod. This can still be changed by the user. - - Returns: - An interface to the new installed mod, or `None` if no installation took place (canceled or failure). - """ - ... - def listDirectories(self, directory: str) -> List[str]: - """ - Retrieve the list of (virtual) subdirectories in the given path. - - Args: - directory: Path to the directory to list (relative to the 'data' folder). - - Returns: - The list of directories in the given directory. - """ - ... - def managedGame(self) -> "IPluginGame": - """ - Returns: - The plugin corresponding to the current game. - """ - ... - def modDataChanged(self, mod: "IModInterface"): - """ - Notify the organizer that the given mod has changed. - - Args: - mod: The mod that has changed. - """ - ... - def modList(self) -> "IModList": - """ - Returns: - The interface to the mod list. - """ - ... - def modsPath(self) -> str: - """ - Returns: - The (absolute) path to the mods directory. - """ - ... - def modsSortedByProfilePriority(self) -> List[str]: - """ - Returns: - The list of mod (names), sorted according to the current profile priorities. - """ - ... - def onAboutToRun(self, callback: Callable[[str], bool]) -> bool: - """ - Install a new handler to be called when an application is about to run. - - Multiple handlers can be installed. If any of the handler returns `False`, the application will - not run. - - Args: - callback: The function to call when an application is about to run. The parameter is the absolute path to the application to run. The function can return False to prevent the application from running. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onFinishedRun(self, callback: Callable[[str, int], None]) -> bool: - """ - Install a new handler to be called when an application has finished running. - - Args: - callback: The function to call when an application has finished running. The first parameter is the absolute path to the application, and the second parameter is the exit code of the application. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onModInstalled(self, callback: Callable[[str], None]) -> bool: - """ - Install a new handler to be called when a new mod is installed. - - Args: - callback: The function to call when a mod is installed. The parameter of the function is the name of the installed mod. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onPluginSettingChanged( - self, callback: Callable[[str, str, MoVariant, MoVariant], None] - ) -> bool: - """ - Install a new handler to be called when a plugin setting is changed. - - Args: - callback: The function to call when a plugin setting is changed. The parameters are: The name of the plugin, the name of the setting, the old value (or `None` if the setting did not exist before) and the new value - of the setting (or `None` if the setting has been removed). - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onProfileChanged( - self, callback: Callable[["IProfile", "IProfile"], None] - ) -> bool: - """ - Install a new handler to be called when the current profile is changed. - - The function is called when the profile is changed but some operations related to - the profile might not be finished when this is called (e.g., the virtual file system - might not be up-to-date). - - Args: - callback: The function to call when the current profile is changed. The first parameter is the old profile (can be `None`, e.g. at startup), and the second parameter is the new profile (cannot be `None`). - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onUserInterfaceInitialized( - self, callback: Callable[[PyQt5.QtWidgets.QMainWindow], None] - ) -> bool: - """ - Install a new handler to be called when the UI has been fully initialized. - - Args: - callback: The function to call when the user-interface has been fully initialized. The parameter is the main window of the application (`QMainWindow`). - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def overwritePath(self) -> str: - """ - Returns: - The (absolute) path to the overwrite directory. - """ - ... - def persistent( - self, plugin_name: str, key: str, default: MoVariant = None - ) -> MoVariant: - """ - Retrieve the specified persistent value for a plugin. - - A persistent is an arbitrary value that the plugin can set and retrieve that is persistently stored - by the main application. There is no UI for the user to change this value but they can directly access - the storage - - Args: - plugin_name: Name of the plugin for which to retrieve the value. This should always be IPlugin::name() unless you have a really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - default: Default value to return if the key is not set (yet). - - Returns: - The value corresponding to the given persistent setting, or `def` is the key is not found. - """ - ... - def pluginDataPath(self) -> str: - """ - Retrieve the path to a directory where plugin data should be stored. - - For python plugins, it is recommended to use a dedicated folder (per plugin) if you need to - store data (resources, or multiple python files). - - Returns: - Path to a directory where plugin data should be stored. - """ - ... - def pluginList(self) -> "IPluginList": - """ - Returns: - The plugin list interface. - """ - ... - def pluginSetting(self, plugin_name: str, key: str) -> MoVariant: - """ - Retrieve settings of plugins. - - Args: - plugin_name: Name of the plugin to retrieve the setting for. - key: Name of the setting to retrieve the value for. - - Returns: - The value of the setting. - """ - ... - def profile(self) -> "IProfile": - """ - Returns: - The interface to the current profile. - """ - ... - def profileName(self) -> str: - """ - Returns: - The name of the current profile, or an empty string if no profile has been loaded (yet). - """ - ... - def profilePath(self) -> str: - """ - Returns: - The absolute path to the active profile or an empty string if no profile has been loaded (yet). - """ - ... - def refreshModList(self, save_changes: bool = True): - """ - Refresh the mod list. - - Args: - save_changes: If True, the relevant profile information is saved first (enabled mods and order of mods). - """ - ... - def removeMod(self, mod: "IModInterface") -> bool: - """ - Remove a mod (from disc and from the UI). - - Args: - mod: The mod to remove. - - Returns: - True if the mod was removed, False otherwise. - """ - ... - def resolvePath(self, filename: str) -> str: - """ - Resolves a path relative to the virtual data directory to its absolute real path. - - Args: - filename: Path to resolve. - - Returns: - The absolute real path, or an empty string if the path was not found. - """ - ... - def setPersistent( - self, plugin_name: str, key: str, value: MoVariant, sync: bool = True - ): - """ - Set the specified persistent value for a plugin. - - This does not update the in-memory value for this setting, see `setPluginSetting()` for this. - - Args: - plugin_name: Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - value: New value for the setting. - sync: If True, the storage is immediately written to disc. This costs performance but is safer against data loss. - """ - ... - def setPluginSetting(self, plugin_name: str, key: str, value: MoVariant): - """ - Set the specified setting for a plugin. - - This automatically notify handlers register with `onPluginSettingChanged`, so you do not have to do it yourself. - - Args: - plugin_name: Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - value: New value for the setting. - """ - ... - def startApplication( - self, - executable: str, - args: List[str] = [], - cwd: str = "", - profile: str = "", - forcedCustomOverwrite: str = "", - ignoreCustomOverwrite: bool = False, - ) -> int: - """ - Starts an application with virtual filesystem active. - - Args: - executable: Name or path of the executable. If this is only a filename, it will only work if it has been configured in MO as an executable. If it is a relative path it is expected to be relative to the game directory. - args: Arguments to pass to the executable. If the list is empty, and `executable` refers to a configured executable, the configured arguments are used. - cwd: The working directory for the executable. If this is empty, the path to the executable is used unless `executable` referred to a configured MO executable, in which case the configured cwd is used. - profile: Profile to use. If this is empty (the default) the current profile is used. - forcedCustomOverwrite: The mod to set as the custom overwrite, regardless of what the profile has configured. - ignoreCustomOverwrite: Set to true to ignore the profile's configured custom overwrite. - - Returns: - The handle to the started application, or 0 if the application failed to start. - """ - ... - def waitForApplication(self, handle: int) -> Tuple[bool, int]: - """ - Wait for the application corresponding to the given handle to finish. - - This will always show the lock overlay, regardless of whether the - user has disabled locking in the setting, so use this with care. - Note that the lock overlay will always allow the user to unlock, in - which case this will return False. - - Args: - handle: Handle of the application to wait for (as returned by `startApplication()`). - - Returns: - A tuple `(result, exitcode)`, where `result` is a boolean indicating if the application - completed successfully, and `exitcode` is the exit code of the application. - """ - ... - -class IPlugin(abc.ABC): - """ - Base class for all plugins. - """ - - def __init__(self): ... - @abc.abstractmethod - def author(self) -> str: - """ - Returns: - The name of the plugin author. - """ - ... - @abc.abstractmethod - def description(self) -> str: - """ - Returns: - The description for this plugin. - """ - ... - @abc.abstractmethod - def init(self, organizer: "IOrganizer") -> bool: - """ - Initialize this plugin. - - Args: - organizer: The main organizer interface. - - Returns: - True if the plugin was initialized correctly, False otherwise. - """ - ... - @abc.abstractmethod - def isActive(self) -> bool: - """ - Check if this plugin is active. - - It is possible to use a plugin setting (specified in `settings()`) here to allow - users to manually enable/disable a plugin. - - Returns: - True if this plugin is active, False otherwise. - """ - ... - @abc.abstractmethod - def name(self) -> str: - """ - Retrieve the name of the plugin. - - The name of the plugin is used for internal storage purpose so it should not change, - and it should be static. In particular, you should not use a localized string (`tr()`) - for the plugin name. - - In the future, we will provide a way to localized plugin names using a distinct method, - such as `localizedName()`. - - Returns: - The name of the plugin. - """ - ... - @abc.abstractmethod - def settings(self) -> List["PluginSetting"]: - """ - Returns: - A list of settings for this plugin. - """ - ... - @abc.abstractmethod - def version(self) -> "VersionInfo": - """ - Returns: - The version of this plugin. - """ - ... - -class IPluginDiagnose(IPlugin): - """ - Plugins that create problem reports to be displayed in the UI. - - This can be used to report problems related to the same plugin (which implements further - interfaces) or as a stand-alone diagnosis tool. - """ - - def __init__(self): ... - def _invalidate(self): - """ - Invalidate the problems corresponding to this plugin. - """ - ... - @abc.abstractmethod - def activeProblems(self) -> List[int]: - """ - Retrieve the list of active problems found by this plugin. - - This method returns a list of problem IDs, that are then used when calling other methods - such as `shortDescription()` or `hasGuidedFix()`. - - Returns: - The list of active problems for this plugin. - """ - ... - @abc.abstractmethod - def fullDescription(self, key: int) -> str: - """ - Retrieve the full description of the problem corresponding to the given key. - - Args: - key: ID of the problem. - - Returns: - The full description of the problem. - - Raises: - IndexError: If the key is not valid. - """ - ... - @abc.abstractmethod - def hasGuidedFix(self, key: int) -> bool: - """ - Check if the problem corresponding to the given key has a guided fix. - - Args: - key: ID of the problem. - - Returns: - True if there is a guided fix for the problem, False otherwise. - - Raises: - IndexError: If the key is not valid. - """ - ... - @abc.abstractmethod - def shortDescription(self, key: int) -> str: - """ - Retrieve the short description of the problem corresponding to the given key. - - Args: - key: ID of the problem. - - Returns: - The short description of the problem. - - Raises: - IndexError: If the key is not valid. - """ - ... - @abc.abstractmethod - def startGuidedFix(self, key: int): - """ - Starts a guided fix for the problem corresponding to the given key. - - This method should throw `ValueError` if there is no guided fix for the corresponding - problem. - - Args: - key: ID of the problem. - - Raises: - IndexError: If the key is not valid. - ValueError: If there is no guided fix for this problem. - """ - ... - -class IPluginFileMapper(IPlugin): - """ - Plugins that adds virtual file links. - """ - - def __init__(self): ... - @abc.abstractmethod - def mappings(self) -> List["Mapping"]: - """ - Returns: - Mapping for the virtual file system (VFS). - """ - ... - -class IPluginGame(IPlugin): - """ - Base classes for game plugins. - - Each game requires a specific game plugin. These plugins were initially designed for - Bethesda games, so a lot of methods and attributes are irrelevant for other games. If - you wish to write a plugin for a much simpler game, please consider the `basic_games` - plugin: https://github.com/ModOrganizer2/modorganizer-basic_games - """ - - def __init__(self): ... - @abc.abstractmethod - def CCPlugins(self) -> List[str]: - """ - Returns: - The current list of active Creation Club plugins. - """ - ... - @abc.abstractmethod - def DLCPlugins(self) -> List[str]: - """ - Returns: - The list of esp/esm files that are part of known DLCs. - """ - ... - @abc.abstractmethod - def binaryName(self) -> str: - """ - Returns: - The name of the default executable to run (relative to the game folder). - """ - ... - @abc.abstractmethod - def dataDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The name of the directory containing data (relative to the game folder). - """ - ... - @abc.abstractmethod - def documentsDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The directory of the documents folder where configuration files and such for this game reside. - """ - ... - @abc.abstractmethod - def executableForcedLoads(self) -> List["ExecutableForcedLoadSetting"]: - """ - Returns: - A list of automatically discovered libraries that can be force loaded with executables. - """ - ... - @abc.abstractmethod - def executables(self) -> List["ExecutableInfo"]: - """ - Returns: - A list of automatically discovered executables of the game itself and tools surrounding it. - """ - ... - def feature(self, feature_type: Type[GameFeatureType]) -> GameFeatureType: - """ - Retrieve a specified game feature from this plugin. - - Args: - feature_type: The class of feature to retrieve. - - Returns: - The game feature corresponding to the given type, or `None` if the feature is - not implemented. - """ - ... - def featureList(self) -> Dict[Type[GameFeatureType], GameFeatureType]: - """ - Retrieve the list of game features implemented for this plugin. - - Python plugin should not implement this method but `_featureList()`. - - Returns: - A mapping from feature type to actual game features. - """ - ... - @abc.abstractmethod - def gameDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The directory containing the game installation. - """ - ... - @abc.abstractmethod - def gameIcon(self) -> PyQt5.QtGui.QIcon: - """ - Returns: - The icon representing the game. - """ - ... - @abc.abstractmethod - def gameName(self) -> str: - """ - Returns: - The name of the game (as displayed to the user). - """ - ... - @abc.abstractmethod - def gameNexusName(self) -> str: - """ - Returns: - The name of the game identifier for Nexus. - """ - ... - @abc.abstractmethod - def gameShortName(self) -> str: - """ - Returns: - The short name of the game. - """ - ... - @abc.abstractmethod - def gameVariants(self) -> List[str]: - """ - Retrieve the list of variants for this game. - - If there are multiple variants of a game (and the variants make a difference to the - plugin), like a regular one and a GOTY-edition, the plugin can return a list of them - and the user gets to chose which one he owns. - - Returns: - The list of variants of the game. - """ - ... - @abc.abstractmethod - def gameVersion(self) -> str: - """ - Returns: - The version of the game. - """ - ... - @abc.abstractmethod - def getLauncherName(self) -> str: - """ - Returns: - The name of the launcher executable to run (relative to the game folder), or an - empty string if there is no launcher. - """ - ... - @abc.abstractmethod - def iniFiles(self) -> List[str]: - """ - Returns: - The list of INI files this game uses. The first file in the list should be the - 'main' INI file. - """ - ... - @abc.abstractmethod - def initializeProfile(self, directory: PyQt5.QtCore.QDir, settings: int): - """ - Initialize a profile for this game. - - The MO app does not yet support virtualizing only specific aspects but plugins should be written - with this future functionality in mind. - - This function will be used to initially create a profile, potentially to repair it or upgrade/downgrade - it so the implementations have to gracefully handle the case that the directory already contains files. - - Args: - directory: The directory where the profile is to be initialized. - settings: The parameters for how the profile should be initialized. - """ - ... - @abc.abstractmethod - def isInstalled(self) -> bool: - """ - Returns: - True if this game has been discovered as installed, False otherwise. - """ - ... - @abc.abstractmethod - def loadOrderMechanism(self) -> "LoadOrderMechanism": - """ - Returns: - The load order mechanism used by this game. - """ - ... - @abc.abstractmethod - def looksValid(self, directory: PyQt5.QtCore.QDir) -> bool: - """ - Check if the given directory looks like a valid game installation. - - Args: - directory: Directory to check. - - Returns: - True if the directory looks like a valid installation of this game, False otherwise. - """ - ... - @abc.abstractmethod - def nexusGameID(self) -> int: - """ - Retrieve the Nexus game ID for this game. - - Example: For Skyrim, the Nexus game ID is 110. - - Returns: - The Nexus game ID for this game. - """ - ... - @abc.abstractmethod - def nexusModOrganizerID(self) -> int: - """ - Retrieve the Nexus mod ID of Mod Organizer for this game. - - Example: For Skyrim SE, the mod ID of MO2 is 6194. You can find the mod ID in the URL: - https://www.nexusmods.com/skyrimspecialedition/mods/6194 - - Returns: - The Nexus mod ID of Mod Organizer for this game. - """ - ... - @abc.abstractmethod - def primaryPlugins(self) -> List[str]: - """ - Returns: - The list of plugins that are part of the game and not considered optional. - """ - ... - @abc.abstractmethod - def primarySources(self) -> List[str]: - """ - Retrieve primary alternative 'short' names for this game. - - This is used to determine if a Nexus (or other) download source should be considered - as a primary source for the game so that it is not flagged as an alternative one. - - Returns: - The list of primary alternative 'short' names for this game, or an empty list. - """ - ... - @abc.abstractmethod - def savegameExtension(self) -> str: - """ - Returns: - The file extension of save games for this game. - """ - ... - @abc.abstractmethod - def savegameSEExtension(self) -> str: - """ - Returns: - The file extension of Script Extender saves for this game. - """ - ... - @abc.abstractmethod - def savesDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The directory where save games are stored. - """ - ... - @abc.abstractmethod - def setGamePath(self, path: str): - """ - Set the path to the managed game. - - This is called during instance creation if the game is not auto-detected and the user has - to specify the installation location. This is not called if the game has been auto-detected, - so `isInstalled()` should call this. - - Args: - path: Path to the game installation. - """ - ... - @abc.abstractmethod - def setGameVariant(self, variant: str): - """ - Set the game variant. - - If there are multiple variants of game (as returned by `gameVariants()`), this will be - called on start with the user-selected game variant. - - Args: - variant: The game variant selected by the user. - """ - ... - @abc.abstractmethod - def sortMechanism(self) -> "SortMechanism": - """ - Returns: - The sort mechanism for this game. - """ - ... - @abc.abstractmethod - def steamAPPId(self) -> str: - """ - Retrieve the Steam app ID for this game. - - If the game is not available on Steam, this should return an empty string. - - If a game is available in multiple versions, those might have different app ids. The plugin - should try to return the right one - - Returns: - The Steam app ID for this game. Should be empty for games not available on steam. - """ - ... - @abc.abstractmethod - def validShortNames(self) -> List[str]: - """ - Retrieve the valid 'short' names for this game. - - This is used to determine if a Nexus download is valid for the current game since not all - game variants have their own nexus pages and others can handle downloads from other nexus - game pages and should be allowed to do so (e.g., you can install some Skyrim LE mod even - when using Skyrim SE). - - The short name should be considered the primary handler for a directly supported game - for puroses of auto-launching an instance. - - Returns: - The list of valid short names for this game. - """ - ... - -class IPluginInstaller(IPlugin): - """ - This is the top-level class for installer. Actual installers should inherit either: - - - `IPluginInstallerSimple` if the installer can work directly with the archive. This is what - most installers use. - - `IPluginInstallerCustom` if the installer needs to perform custom operations. This is only - used by the external NCC installer and the OMOD installer. - """ - - @abc.abstractmethod - def isArchiveSupported(self, tree: "IFileTree") -> bool: - """ - Check if the given file tree corresponds to a supported archive for this installer. - - Args: - tree: The tree representing the content of the archive. - - Returns: - True if this installer can handle the archive, False otherwise. - """ - ... - @abc.abstractmethod - def isManualInstaller(self) -> bool: - """ - Check if this installer is a manual installer. - - Returns: - True if this installer is a manual installer, False otherwise. - """ - ... - @abc.abstractmethod - def priority(self) -> int: - """ - Retrieve the priority of this installer. - - If multiple installers are able to handle an archive, the one with the highest priority wins. - - Returns: - The priority of this installer. - """ - ... - def setInstallationManager(self, manager: "IInstallationManager"): - """ - Set the installation manager for this installer. - - Python plugins usually do not need to re-implement this and can directly access the installation - manager using `_manager()`. - - Args: - manager: The installation manager. - """ - ... - def setParentWidget(self, parent: PyQt5.QtWidgets.QWidget): - """ - Set the parent widget for this installer. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - - Args: - parent: The parent widget. - """ - ... - -class IPluginInstallerCustom(IPluginInstaller): - """ - Custom installer for mods. Custom installers receive the archive name and have to go - from there. They have to be able to extract the archive themself. - - Example of such installers are the external NCC installer or the OMOD installer. - """ - - def __init__(self): ... - def _manager(self) -> "IInstallationManager": - """ - Returns: - The installation manager. - """ - ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def install( - self, - mod_name: "GuessedString", - game_name: str, - archive_name: str, - version: str, - nexus_id: int, - ) -> "InstallResult": - """ - Install the given archive. - - The mod needs to be created by calling `IOrganizer.createMod` first. - - Args: - mod_name: Name of the mod to install. As an input parameter this is the suggested name (e.g. from meta data) The installer may change this parameter to rename the mod). - game_name: Name of the game for which the mod is installed. - archive_name: Name of the archive to install. - version: Version of the mod. May be empty if the version is not yet known. The plugin is responsible for setting the version on the created mod. - nexus_id: ID of the mod or -1 if unknown. The plugin is responsible for setting the mod ID for the created mod. - - Returns: - The result of the installation process. - """ - ... - @overload - @abc.abstractmethod - def isArchiveSupported(self, tree: "IFileTree") -> bool: - """ - Check if the given file tree corresponds to a supported archive for this installer. - - Args: - tree: The tree representing the content of the archive. - - Returns: - True if this installer can handle the archive, False otherwise. - """ - ... - @overload - @abc.abstractmethod - def isArchiveSupported(self, archive_name: str) -> bool: - """ - Check if the given file is a supported archive for this installer. - - Args: - archive_name: Name of the archive. - - Returns: - True if this installer can handle the archive, False otherwise. - """ - ... - @abc.abstractmethod - def supportedExtensions(self) -> List[str]: - """ - Returns: - A list of file extensions that this installer can handle. - """ - ... - -class IPluginInstallerSimple(IPluginInstaller): - """ - Simple installer for mods. Simple installers only deal with an in-memory structure - representing the archive and can modify what to install and where by editing this structure. - Actually extracting the archive is handled by the manager. - """ - - def __init__(self): ... - def _manager(self) -> "IInstallationManager": - """ - Returns: - The installation manager. - """ - ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def install( - self, name: "GuessedString", tree: "IFileTree", version: str, nexus_id: int - ) -> Union[ - "InstallResult", "IFileTree", Tuple["InstallResult", "IFileTree", str, int] - ]: - """ - Install a mod from an archive filetree. - - The installer can modify the given tree and use the manager to extract or create new - files. - - This method returns different type of objects depending on the actual result of the - installation. The C++ bindings for this method always returns a tuple (result, tree, - version, id). - - Args: - name: Name of the mod to install. As an input parameter this is the suggested name (e.g. from meta data) The installer may change this parameter to rename the mod). - tree: In-memory representation of the archive content. - version: Version of the mod, or an empty string is unknown. - nexus_id: ID of the mod, or -1 if unknown. - - Returns: - In case of failure, the result of the installation, otherwise the modified tree or - a tuple (result, tree, version, id) containing the result of the installation, the - modified tree, the new version and the new ID. The tuple can be returned even if the - installation did not succeed. - """ - ... - -class IPluginList: - """ - Primary interface to the list of plugins. - """ - - def isMaster(self, name: str) -> bool: - """ - Check if a plugin is a master file (basically a library, referenced by other plugins). - - In gamebryo games, a master file will usually have a .esm file extension but technically - an esp can be flagged as master and an esm might not be. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - True if the given plugin is a master plugin, False otherwise or if the file does not exist. - """ - ... - def loadOrder(self, name: str) -> int: - """ - Retrieve the load order of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The load order of the plugin (the order in which the game loads it). If all plugins are enabled this - is the same as the priority but disabled plugins will have a load order of -1. This also returns -1 - if the plugin does not exist. - """ - ... - def masters(self, name: str) -> List[str]: - """ - Retrieve the list of masters required for a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The list of masters for the plugin (filenames with extension, no path). - """ - ... - def onPluginMoved(self, callback: Callable[[str, int, int], None]) -> bool: - """ - Install a new handler to be called when a plugin is moved. - - Args: - callback: The function to call when a plugin is moved. The first parameter is the plugin name, the second the old priority of the plugin and the third one the new priority. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onRefreshed(self, callback: Callable[[None], None]) -> bool: - """ - Install a new handler to be called when the list of plugins is refreshed. - - Args: - callback: The function to call when the list of plugins is refreshed. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def origin(self, name: str) -> str: - """ - Retrieve the origin of a plugin. This is either the (internal) name of a mod, `"overwrite"` or `"data"`. - - The internal name of a mod can differ from the display name for disambiguation. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The name of the origin of the plugin, or an empty string if the plugin does not exist. - """ - ... - def pluginNames(self) -> List[str]: - """ - Returns: - The list of all plugin names. - """ - ... - def priority(self, name: str) -> int: - """ - Retrieve the priority of a plugin. - - The higher the priority, the more important. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The priority of the given plugin, or -1 if the plugin does not exist. - """ - ... - def setLoadOrder(self, loadorder: List[str]): - """ - Set the load order. - - Plugins not included in the list will be placed at highest priority in the order they - were before. - - Args: - loadorder: The new load order, specified by the list of plugin names, sorted. - """ - ... - def setState(self, name: str, state: int): - """ - Set the state of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - state: New state of the plugin (`INACTIVE` or `ACTIVE`). - """ - ... - def state(self, name: str) -> int: - """ - Retrieve the state of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The state of the plugin. - """ - ... - -class IPluginModPage(IPlugin): - def __init__(self): ... - @abc.abstractmethod - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def displayName(self) -> str: - """ - Returns: - The name of the page as displayed in the UI. - """ - ... - @abc.abstractmethod - def handlesDownload( - self, - page_url: PyQt5.QtCore.QUrl, - download_url: PyQt5.QtCore.QUrl, - fileinfo: "ModRepositoryFileInfo", - ) -> bool: - """ - Check if the plugin handles the specified download. - - Args: - page_url: URL of the page that contains the download link. - download_url: The download URL. - fileinfo: Not usable in python. - - Returns: - True if this plugin wants to handle the specified download, False otherwise. - """ - ... - @abc.abstractmethod - def icon(self) -> PyQt5.QtGui.QIcon: - """ - Returns: - The icon to display with the page. - """ - ... - @abc.abstractmethod - def pageURL(self) -> PyQt5.QtCore.QUrl: - """ - Returns: - The URL to open when the user wants to visit this mod page. - """ - ... - def setParentWidget(self, parent: PyQt5.QtWidgets.QWidget): - """ - Set the parent widget for this mod page. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - - Args: - parent: The parent widget. - """ - ... - @abc.abstractmethod - def useIntegratedBrowser(self) -> bool: - """ - Indicates if the page should be displayed in the integrated browser. - - Unless the page provides a special means of starting downloads (like the nxm:// url schema - on nexus), it will not be possible to handle downloads unless the integrated browser is used! - - Returns: - True if the page should be opened in the integrated browser, False otherwise. - """ - ... - -class IPluginPreview(IPlugin): - """ - These plugins add support for previewing files in the data pane. Right now all image formats supported - by qt are implemented (including dds) but no audio files and no 3d mesh formats. - """ - - def __init__(self): ... - @abc.abstractmethod - def genFilePreview( - self, filename: str, max_size: PyQt5.QtCore.QSize - ) -> PyQt5.QtWidgets.QWidget: - """ - Generate a preview for the specified file. - - Args: - filename: Path to the file to preview. - max_size: Maximum size of the generated widget. - - Returns: - The widget showing a preview of the file. - """ - ... - @abc.abstractmethod - def supportedExtensions(self) -> List[str]: - """ - Returns: - The list of file extensions that are supported by this preview plugin. - """ - ... - -class IPluginTool(IPlugin): - """ - This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools submenu - and get invoked when the user clicks it. They are expected to have a user interface of some sort. These - are almost like independent applications except they can access all Mod Organizer interfaces like querying - and modifying the current profile, mod list, load order, use MO to install mods and so on. A tool plugin - can (and should!) integrate its UI as a window inside MO and thus doesn't have to initialize a windows - application itself. - """ - - def __init__(self): ... - @abc.abstractmethod - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def display(self): - """ - Called when the user starts the tool. - """ - ... - @abc.abstractmethod - def displayName(self) -> str: - """ - Returns: - The display name for this tool, as shown in the tool menu. - """ - ... - @abc.abstractmethod - def icon(self) -> PyQt5.QtGui.QIcon: - """ - Returns: - The icon for this tool, or a default-constructed QICon(). - """ - ... - def setParentWidget(self, parent: PyQt5.QtWidgets.QWidget): - """ - Set the parent widget for this tool. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - - Args: - parent: The parent widget. - """ - ... - @abc.abstractmethod - def tooltip(self) -> str: - """ - Returns: - The tooltip for this tool. - """ - ... - -class IProfile: - def absolutePath(self) -> str: ... - def invalidationActive(self) -> Tuple[bool, bool]: ... - def localSavesEnabled(self) -> bool: ... - def localSettingsEnabled(self) -> bool: ... - def name(self) -> str: ... - -class ISaveGame: - """ - Base class for information about what is in a save game. - """ - - def __init__(self): ... - def allFiles(self) -> List[str]: - """ - Returns: - The list of all files related to this save. - """ - ... - def getCreationTime(self) -> PyQt5.QtCore.QDateTime: - """ - Retrieve the creation time of the save. - - The creation time of a save is not always the same as the creation time of - the file containing the save. - - Returns: - The creation time of the save. - """ - ... - def getFilename(self) -> str: - """ - Returns: - The name of the (main) save file. - """ - ... - def getSaveGroupIdentifier(self) -> str: - """ - Retrieve the name of the group this files belong to. - - The name can be used to identify sets of saves to transfer between profiles. For - RPG games, this is usually the name of a character. - - Returns: - The group identifier for this save game. - """ - ... - def hasScriptExtenderFile(self) -> bool: - """ - Returns: - True if this save game has an associated script extender save, False otherwise. - """ - ... - -class ISaveGameInfoWidget(PyQt5.QtWidgets.QWidget): - """ - Base class for a save game info widget. - """ - - def __init__(self, parent: PyQt5.QtWidgets.QWidget = None): - """ - Args: - parent: Parent widget. - """ - ... - def _widget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The underlying `QWidget`. - """ - ... - @abc.abstractmethod - def setSave(self, save: str): - """ - Set the save file to display in this widget. - - Args: - save: Path to the save file. - """ - ... - -class LocalSavegames(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def mappings(self, profile_save_dir: PyQt5.QtCore.QDir) -> List["Mapping"]: ... - @abc.abstractmethod - def prepareProfile(self, profile: "IProfile") -> bool: ... - -class Mapping: - @property - def createTarget(self) -> bool: ... - @createTarget.setter - def createTarget(self, arg0: bool): ... - @property - def destination(self) -> str: ... - @destination.setter - def destination(self, arg0: str): ... - @property - def isDirectory(self) -> bool: ... - @isDirectory.setter - def isDirectory(self, arg0: bool): ... - @property - def source(self) -> str: ... - @source.setter - def source(self, arg0: str): ... - def __init__(self): - """ - Creates an empty Mapping. - """ - ... - -class ModDataChecker(abc.ABC): - """ - Game feature that is used to check the content of a data tree. - """ - - class CheckReturn(Enum): - INVALID = ... - FIXABLE = ... - VALID = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - FIXABLE: "ModDataChecker.CheckReturn" = ... - INVALID: "ModDataChecker.CheckReturn" = ... - VALID: "ModDataChecker.CheckReturn" = ... - def __init__(self): ... - @abc.abstractmethod - def dataLooksValid(self, filetree: "IFileTree") -> "ModDataChecker.CheckReturn": - """ - Check that the given filetree represent a valid mod layout, or can be easily - fixed. - - This method is mainly used during installation (to find which installer should - be used or to recurse into multi-level archives), or to quickly indicates to a - user if a mod looks valid. - - This method does not have to be exact, it only has to indicate if the given tree - looks like a valid mod or not by quickly checking the structure (heavy operations - should be avoided). - - If the tree can be fixed by the `fix()` method, this method should return `FIXABLE`. - `FIXABLE` should only be returned when it is guaranteed that `fix()` can fix the tree. - - Args: - filetree: The tree starting at the root of the "data" folder. - - Returns: - Whether the tree is invalid, fixable or valid. - """ - ... - def fix(self, filetree: "IFileTree") -> Optional["IFileTree"]: - """ - Try to fix the given tree. - - This method is used during installation to try to fix invalid archives and will only be - called if dataLooksValid returned `FIXABLE`. - - Args: - filetree: The tree to try to fix. Can be modified during the process. - - Returns: - The fixed tree, or a null pointer if the tree could not be fixed. - """ - ... - -class ModDataContent(abc.ABC): - """ - The ModDataContent feature is used (when available) to indicate to users the content - of mods in the "Content" column. - - The feature exposes a list of possible content types, each associated with an ID, a name - and an icon. The icon is the path to either: - - - A Qt resource or; - - A file on the disk. - - In order to facilitate the implementation, MO2 already provides a set of icons that can - be used. Those icons are all under ``:/MO/gui/content`` (e.g. ``:/MO/gui/content/plugin`` or ``:/MO/gui/content/music`` `). - - The list of available icons is: - - - ``plugin``: |plugin-icon| - - ``skyproc``: |skyproc-icon| - - ``texture``: |texture-icon| - - ``music``: |music-icon| - - ``sound``: |sound-icon| - - ``interface``: |interface-icon| - - ``skse``: |skse-icon| - - ``script``: |script-icon| - - ``mesh``: |mesh-icon| - - ``string``: |string-icon| - - ``bsa``: |bsa-icon| - - ``menu``: |menu-icon| - - ``inifile``: |inifile-icon| - - ``modgroup``: |modgroup-icon| - - .. |plugin-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/jigsaw-piece.png - .. |skyproc-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/hand-of-god.png - .. |texture-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/empty-chessboard.png - .. |music-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/double-quaver.png - .. |sound-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/lyre.png - .. |interface-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/usable.png - .. |skse-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/checkbox-tree.png - .. |script-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/tinker.png - .. |mesh-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/breastplate.png - .. |string-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/conversation.png - .. |bsa-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/locked-chest.png - .. |menu-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/config.png - .. |inifile-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/feather-and-scroll.png - .. |modgroup-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/xedit.png - """ - - class Content: - @property - def icon(self) -> str: ... - @property - def id(self) -> int: ... - @property - def name(self) -> str: ... - def __init__(self, id: int, name: str, icon: str, filter_only: bool = False): - """ - Args: - id: ID of this content. - name: Name of this content. - icon: Path to the icon for this content. Can be either a path to an image on the disk, or to a resource. Can be an empty string if filterOnly - is true. - filter_only: Indicates if the content should only be show in the filter criteria and not in the actual Content column. - """ - ... - def isOnlyForFilter(self) -> bool: - """ - Returns: - True if this content is only meant to be used as a filter criteria. - """ - ... - def __init__(self): ... - @abc.abstractmethod - def getAllContents(self) -> List["ModDataContent.Content"]: - """ - Returns: - The list of all possible contents for the corresponding game. - """ - ... - @abc.abstractmethod - def getContentsFor(self, filetree: "IFileTree") -> List[int]: - """ - Retrieve the list of contents in the given tree. - - Args: - filetree: The tree corresponding to the mod to retrieve contents for. - - Returns: - The IDs of the content in the given tree. - """ - ... - -class ModRepositoryFileInfo: - @property - def categoryID(self) -> int: ... - @categoryID.setter - def categoryID(self, arg0: int): ... - @property - def description(self) -> str: ... - @description.setter - def description(self, arg0: str): ... - @property - def fileCategory(self) -> int: ... - @fileCategory.setter - def fileCategory(self, arg0: int): ... - @property - def fileID(self) -> int: ... - @fileID.setter - def fileID(self, arg0: int): ... - @property - def fileName(self) -> str: ... - @fileName.setter - def fileName(self, arg0: str): ... - @property - def fileSize(self) -> int: ... - @fileSize.setter - def fileSize(self, arg0: int): ... - @property - def fileTime(self) -> PyQt5.QtCore.QDateTime: ... - @fileTime.setter - def fileTime(self, arg0: PyQt5.QtCore.QDateTime): ... - @property - def gameName(self) -> str: ... - @gameName.setter - def gameName(self, arg0: str): ... - @property - def modID(self) -> int: ... - @modID.setter - def modID(self, arg0: int): ... - @property - def modName(self) -> str: ... - @modName.setter - def modName(self, arg0: str): ... - @property - def name(self) -> str: ... - @name.setter - def name(self, arg0: str): ... - @property - def newestVersion(self) -> "VersionInfo": ... - @newestVersion.setter - def newestVersion(self, arg0: "VersionInfo"): ... - @property - def repository(self) -> str: ... - @repository.setter - def repository(self, arg0: str): ... - @property - def uri(self) -> str: ... - @uri.setter - def uri(self, arg0: str): ... - @property - def userData(self) -> MoVariant: ... - @userData.setter - def userData(self, arg0: MoVariant): ... - @property - def version(self) -> "VersionInfo": ... - @version.setter - def version(self, arg0: "VersionInfo"): ... - @overload - def __init__(self, other: "ModRepositoryFileInfo"): ... - @overload - def __init__( - self, game_name: str = None, mod_id: int = None, file_id: int = None - ): ... - def __str__(self) -> str: ... - @staticmethod - def createFromJson(data: str) -> "ModRepositoryFileInfo": ... - -class PluginSetting: - """ - Class to hold the user-configurable parameters a plugin accepts. The purpose of this class is - only to inform the application what settings to offer to the user, it does not hold the actual value. - """ - - @property - def default_value(self) -> MoVariant: ... - @default_value.setter - def default_value(self, arg0: MoVariant): ... - @property - def description(self) -> str: ... - @description.setter - def description(self, arg0: str): ... - @property - def key(self) -> str: ... - @key.setter - def key(self, arg0: str): ... - def __init__(self, key: str, description: str, default_value: MoVariant): - """ - Args: - key: Name of the setting. - description: Description of the setting. - default_value: Default value of the setting. - """ - ... - -class SaveGameInfo(abc.ABC): - """ - Feature to get hold of stuff to do with save games. - """ - - def __init__(self): ... - @abc.abstractmethod - def getMissingAssets(self, filepath: str) -> Dict[str, List[str]]: - """ - Retrieve missing assets from the save. - - Args: - filepath: Path to the save file. - - Returns: - A collection of missing assets and the modules that can supply those assets. - """ - ... - @abc.abstractmethod - def getSaveGameInfo(self, filepath: str) -> "ISaveGame": - """ - Retrieve the information about the supplied save game. - - Args: - filepath: Path to the save file. - - Returns: - A SaveGame corresponding to the given save file. - """ - ... - @abc.abstractmethod - def getSaveGameWidget( - self, parent: PyQt5.QtWidgets.QWidget - ) -> Optional["ISaveGameInfoWidget"]: - """ - Retrieve a widget to display over the save game list. - - This method is allowed to return `None` in case no widget has been implemented. - - Args: - parent: The parent widget. - - Returns: - A SaveGameInfoWidget to display information about save game. - """ - ... - @abc.abstractmethod - def hasScriptExtenderSave(self, filepath: str) -> bool: - """ - Check whether or not the save has a paired script extender save. - - Args: - filepath: Path to the save file. - - Returns: - True if the given save file has a paired script extender save, False otherwise. - """ - ... - -class ScriptExtender(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def BinaryName(self) -> str: - """ - Returns: - The name of the script extender binary. - """ - ... - @abc.abstractmethod - def PluginPath(self) -> str: - """ - Returns: - The script extender plugin path, relative to the data folder. - """ - ... - @abc.abstractmethod - def getArch(self) -> int: - """ - Returns: - The CPU platform of the extender. - """ - ... - @abc.abstractmethod - def getExtenderVersion(self) -> str: - """ - Returns: - The version of the script extender. - """ - ... - @abc.abstractmethod - def isInstalled(self) -> bool: - """ - Returns: - True if the script extender is installed, False otherwise. - """ - ... - @abc.abstractmethod - def loaderName(self) -> str: - """ - Returns: - The loader to use to ensure the game runs with the script extender. - """ - ... - @abc.abstractmethod - def loaderPath(self) -> str: - """ - Returns: - The fullpath to the script extender loader. - """ - ... - @abc.abstractmethod - def saveGameAttachmentExtensions(self) -> List[str]: - """ - Returns: - Additional savegame attachments. - """ - ... - -class UnmanagedMods(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def displayName(self, mod_name: str) -> str: - """ - Retrieve the display name of a given mod. - - Args: - mod_name: Internal name of the mod. - - Returns: - The display name of the mod. - """ - ... - @abc.abstractmethod - def mods(self, official_only: bool) -> List[str]: - """ - Retrieve the list of unmanaged mods for the corresponding game. - - Args: - official_only: Retrieve only unmanaged official mods. - - Returns: - The list of unmanaged mods (internal names). - """ - ... - @abc.abstractmethod - def referenceFile(self, mod_name: str) -> PyQt5.QtCore.QFileInfo: - """ - Retrieve the reference file for the requested mod. - - Example: For Bethesda games, the reference file may be the main - plugin (esp or esm) for the game or a DLCs. - - Args: - mod_name: Internal name of the mod. - - Returns: - The reference file (absolute path) for the requested mod. - """ - ... - @abc.abstractmethod - def secondaryFiles(self, mod_name: str) -> List[str]: - """ - Retrieve the secondary files for the requested mod. - - Example: For Bethesda games, the secondary files may be the archives - corresponding to the reference file. - - Args: - mod_name: Internal name of the mod. - - Returns: - The secondary files (absolute paths) for the request mod. - """ - ... - -class VersionInfo: - """ - Represents the version of a mod or plugin. - """ - - @overload - def __init__(self): - """ - Construct an invalid VersionInfo. - """ - ... - @overload - def __init__(self, value: str, scheme: "VersionScheme" = VersionScheme.DISCOVER): - """ - Construct a VersionInfo by parsing the given string according to the given scheme. - - Args: - value: String to parse. - scheme: Scheme to use to parse the string. - """ - ... - @overload - def __init__( - self, - major: int, - minor: int, - subminor: int, - subsubminor: int, - release_type: "ReleaseType" = ReleaseType.FINAL, - ): - """ - Construct a VersionInfo using the given elements. - - Args: - major: Major version. - minor: Minor version. - subminor: Subminor version. - subsubminor: Subsubminor version. - release_type: Type of release. - """ - ... - @overload - def __init__( - self, - major: int, - minor: int, - subminor: int, - release_type: "ReleaseType" = ReleaseType.FINAL, - ): - """ - Construct a VersionInfo using the given elements. - - Args: - major: Major version. - minor: Minor version. - subminor: Subminor version. - release_type: Type of release. - """ - ... - @overload - def __eq__(self, arg2: "VersionInfo") -> bool: ... - @overload - def __eq__(self, other: object) -> bool: ... - def __ge__(self, arg2: "VersionInfo") -> bool: ... - def __gt__(self, arg2: "VersionInfo") -> bool: ... - def __le__(self, arg2: "VersionInfo") -> bool: ... - def __lt__(self, arg2: "VersionInfo") -> bool: ... - @overload - def __ne__(self, arg2: "VersionInfo") -> bool: ... - @overload - def __ne__(self, other: object) -> bool: ... - def __str__(self) -> str: - """ - Returns: - See `canonicalString()`. - """ - ... - def canonicalString(self) -> str: - """ - Returns: - A canonical string representing this version, that can be stored and then parsed using the parse() method. - """ - ... - def clear(self): - """ - Resets this VersionInfo to an invalid version. - """ - ... - def displayString(self, forced_segments: int = 2) -> str: - """ - Args: - forced_segments: The number of version segments to display even if the version is 0. 1 is major, 2 is major and minor, etc. The only implemented ranges are (-inf,2] for major/minor, [3] for major/minor/subminor, - and [4,inf) for major/minor/subminor/subsubminor. This only versions with a regular scheme. - - Returns: - A string for display to the user. The returned string may not contain enough information to reconstruct this version info. - """ - ... - def isValid(self) -> bool: - """ - Returns: - True if this VersionInfo is valid, False otherwise. - """ - ... - def parse( - self, - value: str, - scheme: "VersionScheme" = VersionScheme.DISCOVER, - manual_input: bool = False, - ): - """ - Update this VersionInfo by parsing the given string using the given scheme. - - Args: - value: String to parse. - scheme: Scheme to use to parse the string. - manual_input: True if the given string should be treated as user input. - """ - ... - def scheme(self) -> "VersionScheme": - """ - Returns: - The version scheme in effect for this VersionInfo. - """ - ... diff --git a/stubs/2.3.2/mobase.pyi b/stubs/2.3.2/mobase.pyi deleted file mode 100644 index 342e071..0000000 --- a/stubs/2.3.2/mobase.pyi +++ /dev/null @@ -1,3481 +0,0 @@ -__version__ = "2.3.2.post2" - -import abc -from enum import Enum -from typing import ( - Dict, - Iterator, - List, - Tuple, - Union, - Any, - Optional, - Callable, - overload, - TypeVar, - Type, -) -import PyQt5.QtCore -import PyQt5.QtGui -import PyQt5.QtWidgets - -MoVariant = Union[None, bool, int, str, List[Any], Dict[str, Any]] -GameFeatureType = TypeVar("GameFeatureType") - -class InterfaceNotImplemented: ... - -def getFileVersion(filepath: str) -> str: - """ - Retrieve the file version of the given executable. - - Args: - filepath: Absolute path to the executable. - - Returns: - The file version, or an empty string if the file version could not be retrieved. - """ - ... - -def getIconForExecutable(executable: str) -> PyQt5.QtGui.QIcon: - """ - Retrieve the icon of an executable. Currently this always extracts the biggest icon. - - Args: - executable: Absolute path to the executable. - - Returns: - The icon for this executable, if any. - """ - ... - -def getProductVersion(executable: str) -> str: - """ - Retrieve the product version of the given executable. - - Args: - executable: Absolute path to the executable. - - Returns: - The product version, or an empty string if the product version could not be retrieved. - """ - ... - -class GuessQuality(Enum): - """ - Describes how good the code considers a guess (i.e. for a mod name) this is used to - determine if a name from another source should overwrite or not. - """ - - INVALID = ... - FALLBACK = ... - GOOD = ... - META = ... - PRESET = ... - USER = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class InstallResult(Enum): - SUCCESS = ... - FAILED = ... - CANCELED = ... - MANUAL_REQUESTED = ... - NOT_ATTEMPTED = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class LoadOrderMechanism(Enum): - FILE_TIME = ... - PLUGINS_TXT = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class ModState(Enum): - EXISTS = ... - ACTIVE = ... - ESSENTIAL = ... - EMPTY = ... - ENDORSED = ... - VALID = ... - ALTERNATE = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class PluginState(Enum): - MISSING = ... - INACTIVE = ... - ACTIVE = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class ProfileSetting(Enum): - MODS = ... - CONFIGURATION = ... - SAVEGAMES = ... - PREFER_DEFAULTS = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class ReleaseType(Enum): - PRE_ALPHA = ... - ALPHA = ... - BETA = ... - CANDIDATE = ... - FINAL = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class SortMechanism(Enum): - NONE = ... - MLOX = ... - BOSS = ... - LOOT = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class VersionScheme(Enum): - DISCOVER = ... - REGULAR = ... - DECIMAL_MARK = ... - NUMBERS_AND_LETTERS = ... - DATE = ... - LITERAL = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class BSAInvalidation(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def activate(self, profile: "IProfile"): ... - @abc.abstractmethod - def deactivate(self, profile: "IProfile"): ... - @abc.abstractmethod - def isInvalidationBSA(self, name: str) -> bool: ... - -class DataArchives(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def addArchive(self, profile: "IProfile", index: int, name: str): - """ - Add an archive to the archive list. - - Args: - profile: Profile to add the archive to. - index: Index to insert before. Use 0 for the beginning of the list or INT_MAX for the end of the list). - name: Name of the archive to add. - """ - ... - @abc.abstractmethod - def archives(self, profile: "IProfile") -> List[str]: - """ - Retrieve the list of archives in the given profile. - - Args: - profile: Profile to retrieve archives from. - - Returns: - The list of archives in the given profile. - """ - ... - @abc.abstractmethod - def removeArchive(self, profile: "IProfile", name: str): - """ - Remove the given archive from the given profile. - - Args: - profile: Profile to remove the archive from. - name: Name of the archive to remove. - """ - ... - @abc.abstractmethod - def vanillaArchives(self) -> List[str]: - """ - Retrieve the list of vanilla archives. - - Vanilla archives are archive files that are shipped with the original - game. - - Returns: - The list of vanilla archives. - """ - ... - -class ExecutableForcedLoadSetting: - def __init__(self, process: str, library: str): ... - def enabled(self) -> bool: ... - def forced(self) -> bool: ... - def library(self) -> str: ... - def process(self) -> str: ... - def withEnabled(self, enabled: bool) -> "ExecutableForcedLoadSetting": ... - def withForced(self, forced: bool) -> "ExecutableForcedLoadSetting": ... - -class ExecutableInfo: - def __init__(self, title: str, binary: PyQt5.QtCore.QFileInfo): ... - def arguments(self) -> List[str]: ... - def asCustom(self) -> "ExecutableInfo": ... - def binary(self) -> PyQt5.QtCore.QFileInfo: ... - def isCustom(self) -> bool: ... - def isValid(self) -> bool: ... - def steamAppID(self) -> str: ... - def title(self) -> str: ... - def withArgument(self, argument: str) -> "ExecutableInfo": ... - def withSteamAppId(self, app_id: str) -> "ExecutableInfo": ... - def withWorkingDirectory( - self, directory: PyQt5.QtCore.QDir - ) -> "ExecutableInfo": ... - def workingDirectory(self) -> PyQt5.QtCore.QDir: ... - -class FileInfo: - """ - Information about a virtualised file - """ - - @property - def archive(self) -> str: ... - @archive.setter - def archive(self, arg0: str): ... - @property - def filePath(self) -> str: ... - @filePath.setter - def filePath(self, arg0: str): ... - @property - def origins(self) -> List[str]: ... - @origins.setter - def origins(self, arg0: List[str]): ... - def __init__(self): - """ - Creates an uninitialized FileInfo. - """ - ... - -class FileTreeEntry: - """ - Represent an entry in a file tree, either a file or a directory. This class - inherited by IFileTree so that operations on entry are the same for a file or - a directory. - - This class provides convenience methods to query information on the file, like its - name or the its last modification time. It also provides a convenience astree() method - that can be used to retrieve the tree corresponding to its entry in case the entry - represent a directory. - """ - - class FileTypes(Enum): - """ - Enumeration of the different file type or combinations. - """ - - DIRECTORY = ... - FILE = ... - FILE_OR_DIRECTORY = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - DIRECTORY: "FileTreeEntry.FileTypes" = ... - FILE: "FileTreeEntry.FileTypes" = ... - FILE_OR_DIRECTORY: "FileTreeEntry.FileTypes" = ... - @overload - def __eq__(self, arg2: str) -> bool: ... - @overload - def __eq__(self, arg2: "FileTreeEntry") -> bool: ... - @overload - def __eq__(self, other: object) -> bool: ... - def __repr__(self) -> str: ... - def detach(self) -> bool: - """ - Detach this entry from its parent tree. - - Returns: - True if the entry was removed correctly, False otherwize. - """ - ... - def fileType(self) -> "FileTreeEntry.FileTypes": - """ - Returns: - The filetype of this entry. - """ - ... - @overload - def hasSuffix(self, suffixes: List[str]) -> bool: - """ - Check if this entry has one of the given suffixes. - - Args: - suffixes: Suffixes to check. - - Returns: - True if this entry is a file and has one of the given suffix. - """ - ... - @overload - def hasSuffix(self, suffix: str) -> bool: - """ - Check if this entry has the given suffix. - - Args: - suffix: Suffix to check. - - Returns: - True if this entry is a file and has the given suffix. - """ - ... - def isDir(self) -> bool: - """ - Returns: - True if this entry is a directory, False otherwise. - """ - ... - def isFile(self) -> bool: - """ - Returns: - True if this entry is a file, False otherwise. - """ - ... - def moveTo(self, tree: "IFileTree") -> bool: - """ - Move this entry to the given tree. - - Args: - tree: The tree to move this entry to. - - Returns: - True if the entry was moved correctly, False otherwize. - """ - ... - def name(self) -> str: - """ - Returns: - The name of this entry. - """ - ... - def parent(self) -> Optional["IFileTree"]: - """ - Returns: - The parent tree containing this entry, or a `None` if this entry is the root - or the parent tree is unreachable. - """ - ... - def path(self, sep: str = "\\") -> str: - """ - Retrieve the path from this entry up to the root of the tree. - - This method propagate up the tree so is not constant complexity as - the full path is never stored. - - Args: - sep: The type of separator to use to create the path. - - Returns: - The path from this entry to the root, including the name of this entry. - """ - ... - def pathFrom(self, tree: "IFileTree", sep: str = "\\") -> str: - """ - Retrieve the path from the given tree to this entry. - - Args: - tree: The tree to reach, must be a parent of this entry. - sep: The type of separator to use to create the path. - - Returns: - The path from the given tree to this entry, including the name of this entry, or - an empty string if the given tree is not a parent of this entry. - """ - ... - def suffix(self) -> str: - """ - Retrieve the "last" extension of this entry. - - The "last" extension is everything after the last dot in the file name. - - Returns: - The last extension of this entry, or an empty string if the file has no extension - or is directory. - """ - ... - -class GamePlugins(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def getLoadOrder(self) -> List[str]: ... - @abc.abstractmethod - def lightPluginsAreSupported(self) -> bool: - """ - Returns: - True if light plugins are supported, False otherwise. - """ - ... - @abc.abstractmethod - def readPluginLists(self, plugin_list: "IPluginList"): ... - @abc.abstractmethod - def writePluginLists(self, plugin_list: "IPluginList"): ... - -class GuessedString: - """ - Represents a string that may be set from different places. Each time the value is - changed a "quality" is specified to say how probable it is the value is the best choice. - Only the best choice should be used in the end but alternatives can be queried. This - class also allows a filter to be set. If a "guess" doesn't pass the filter, it is ignored. - """ - - @overload - def __init__(self): - """ - Creates a GuessedString with no associated value. - """ - ... - @overload - def __init__(self, value: str, quality: "GuessQuality"): - """ - Creates a GuessedString with the given value and quality. - - Args: - value: Initial value of the GuessedString. - quality: Quality of the initial value. - """ - ... - def __str__(self) -> str: ... - @overload - def reset(self) -> "GuessedString": - """ - Reset this GuessedString to an invalid state. - - Returns: - This GuessedString object. - """ - ... - @overload - def reset(self, value: str, quality: "GuessQuality") -> "GuessedString": - """ - Reset this GuessedString object with the given value and quality, only - if the given quality is better than the current one. - - Args: - value: New value for this GuessedString. - quality: Quality of the new value. - - Returns: - This GuessedString object. - """ - ... - @overload - def reset(self, other: "GuessedString") -> "GuessedString": - """ - Reset this GuessedString object by copying the given one, only - if the given one has better quality. - - Args: - other: The GuessedString to copy. - - Returns: - This GuessedString object. - """ - ... - def setFilter(self, filter: Callable[[str], Union[str, bool]]): - """ - Set the filter for this GuessedString. - - The filter is applied on every `update()` and can reject the new value - altogether or modify it (by returning a new value). - - Args: - filter: The new filter. - """ - ... - @overload - def update(self, value: str) -> "GuessedString": - """ - Update this GuessedString by adding the given value to the list of variants - and setting the actual value without changing the current quality of this - GuessedString. - - The GuessedString is only updated if the given value passes the filter. - - Args: - value: The new value for this string. - - Returns: - This GuessedString object. - """ - ... - @overload - def update(self, value: str, quality: "GuessQuality") -> "GuessedString": - """ - Update this GuessedString by adding a new variants with the given quality. - - If the specified quality is better than the current one, the actual value of - the GuessedString is also updated. - - The GuessedString is only updated if the given value passes the filter. - - Args: - value: The new variant to add. - quality: The quality of the variant. - - Returns: - This GuessedString object. - """ - ... - def variants(self) -> List[str]: - """ - Returns: - The list of variants for this GuessedString. - """ - ... - -class IDownloadManager(PyQt5.QtCore.QObject): - downloadComplete: PyQt5.QtCore.pyqtSignal = ... - downloadPaused: PyQt5.QtCore.pyqtSignal = ... - downloadFailed: PyQt5.QtCore.pyqtSignal = ... - downloadRemoved: PyQt5.QtCore.pyqtSignal = ... - def _object(self) -> PyQt5.QtCore.QObject: - """ - Returns: - The underlying `QObject` for the manager. - """ - ... - def downloadPath(self, id: int) -> str: - """ - Retrieve the (absolute) path of the specified download. - - Args: - id: ID of the download. - - Returns: - The absolute path to the file corresponding to the given download. This file - may not exist yet if the download is incomplete. - """ - ... - def startDownloadNexusFile(self, mod_id: int, file_id: int) -> int: - """ - Download a file from www.nexusmods.com/. is always the game - currently being managed. - - Args: - mod_id: ID of the mod to download the file from. - file_id: ID of the file to download. - - Returns: - An ID identifying the download. - """ - ... - def startDownloadURLs(self, urls: List[str]) -> int: - """ - Download a file by url. - - The list can contain alternative URLs to allow the download manager to switch - in case of download problems - - Args: - urls: List of urls to download from. - - Returns: - An ID identifying the download. - """ - ... - -class IFileTree(FileTreeEntry): - """ - Interface to classes that provides way to visualize and alter file trees. The tree - may not correspond to an actual file tree on the disk (e.g., inside an archive, - from a QTree Widget, ...). - - Read-only operations on the tree are thread-safe, even when the tree has not been populated - yet. - - In order to prevent wrong usage of the tree, implementing classes may throw - UnsupportedOperationException if an operation is not supported. By default, all operations - are supported, but some may not make sense in many situations. - - The goal of this is not reflect the change made to a IFileTree to the disk, but child - classes may override relevant methods to do so. - - The tree is built upon FileTreeEntry. A given tree holds shared pointers to its entries - while each entry holds a weak pointer to its parent, this means that the descending link - are strong (shared pointers) but the uplink are weaks. - - Accessing the parent is always done by locking the weak pointer so that returned pointer - or either null or valid. This structure implies that as long as the initial root lives, - entry should not be destroyed, unless the entry are detached from the root and no shared - pointers are kept. - - However, it is not guarantee that one can go up the tree from a single node entry. If the - root node is destroyed, it will not be possible to go up the tree, even if we still have - a valid shared pointer. - """ - - class InsertPolicy(Enum): - FAIL_IF_EXISTS = ... - REPLACE = ... - MERGE = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - class WalkReturn(Enum): - """ - Enumeration that can be returned by the callback for the `walk()` method to stop the - walking operation early. - """ - - CONTINUE = ... - STOP = ... - SKIP = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - CONTINUE: "IFileTree.WalkReturn" = ... - FAIL_IF_EXISTS: "IFileTree.InsertPolicy" = ... - MERGE: "IFileTree.InsertPolicy" = ... - REPLACE: "IFileTree.InsertPolicy" = ... - SKIP: "IFileTree.WalkReturn" = ... - STOP: "IFileTree.WalkReturn" = ... - def __bool__(self) -> bool: - """ - Returns: - True if this tree is not empty, False otherwise. - """ - ... - def __getitem__(self, index: int) -> "FileTreeEntry": - """ - Retrieve the entry at the given index in this tree. - - Args: - index: Index of the entry to retrieve, must be less than the size. - - Returns: - The entry at the given index. - - Raises: - IndexError: If the given index is not in range for this tree. - """ - ... - def __iter__(self) -> Iterator[FileTreeEntry]: - """ - Retrieves an iterator for entries directly under this tree. - - This method does not recurse into subtrees, see `walk()` for this. - - Returns: - An iterator object that can be used to iterate over entries in this tree. - """ - ... - def __len__(self) -> int: - """ - Returns: - The number of entries directly under this tree. - """ - ... - def __repr__(self) -> str: ... - def addDirectory(self, path: str) -> "IFileTree": - """ - Create a new directory tree under this tree. - - This method will create missing folders in the given path and will - not fail if the directory already exists but will fail if the given - path contains "." or "..". - This method invalidates iterators to this tree and all the subtrees - present in the given path. - - Args: - path: Path to the directory to create. - - Returns: - An IFileTree corresponding to the created directory. - - Raises: - RuntimeError: If the directory could not be created. - """ - ... - def addFile(self, path: str, replace_if_exists: bool = False) -> "FileTreeEntry": - """ - Create a new file directly under this tree. - - This method will fail if the file already exists and `replace_if_exists` is `False`. - This method invalidates iterators to this tree and all the subtrees present in the - given path. - - Args: - path: Path to the file to create. - replace_if_exists: If True and an entry already exists at the given location, it will be replaced by a new entry. This will replace both files and directories. - - Returns: - A FileTreeEntry corresponding to the created file. - - Raises: - RuntimeError: If the file could not be created. - """ - ... - def clear(self) -> bool: - """ - Delete (detach) all the entries from this tree. - - This method will go through the entries in this tree and stop at the first - entry that cannot be deleted, this means that the tree can be partially cleared. - - Returns: - True if all entries have been detached, False otherwise. - """ - ... - def copy( - self, - entry: "FileTreeEntry", - path: str = "", - policy: "IFileTree.InsertPolicy" = InsertPolicy.FAIL_IF_EXISTS, - ) -> "FileTreeEntry": - """ - Move the given entry to the given path under this tree. - - The entry must not be a parent tree of this tree. This method can also be used - to rename entries. - - If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry - at the same location already exists. If the policy is REPLACE, an existing - entry will be replaced. If MERGE, the entry will be merged with the existing - one (if the entry is a file, and a file exists, the file will be replaced). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - - Args: - entry: Entry to copy. - path: The path to copy the entry to. If the path ends with / or \\, the entry will be copied in the corresponding directory instead of replacing it. If the - given path is empty (`""`), the entry is copied directly under this tree. - policy: Policy to use to resolve conflicts. - - Returns: - The new entry (copy of the specified entry). - - Raises: - RuntimeError: If the entry could not be copied. - """ - ... - def createOrphanTree(self, name: str = "") -> "IFileTree": - """ - Create a new orphan empty tree. - - Args: - name: Name of the tree. - - Returns: - A new tree without any parent. - """ - ... - def exists( - self, - path: str, - type: "FileTreeEntry.FileTypes" = FileTreeEntry.FileTypes.FILE_OR_DIRECTORY, - ) -> bool: - """ - Check if the given entry exists. - - Args: - path: Path to the entry, separated by / or \\. - type: The type of the entry to check. - - Returns: - True if the entry was found, False otherwise. - """ - ... - def find( - self, - path: str, - type: "FileTreeEntry.FileTypes" = FileTreeEntry.FileTypes.FILE_OR_DIRECTORY, - ) -> Optional[Union["IFileTree", "FileTreeEntry"]]: - """ - Retrieve the given entry. - - If no entry exists at the given path, or if the entry is not of the right - type, `None` is returned. - - Args: - path: Path to the entry, separated by / or \\. - type: The type of the entry to check. - - Returns: - The entry at the given location, or `None` if the entry was not found or - was not of the correct type. - """ - ... - def insert( - self, - entry: "FileTreeEntry", - policy: "IFileTree.InsertPolicy" = InsertPolicy.FAIL_IF_EXISTS, - ) -> bool: - """ - Insert the given entry in this tree, removing it from its - previouis parent. - - The entry must not be this tree or a parent entry of this tree. - - - If the insert policy if `FAIL_IF_EXISTS`, the call will fail if an entry - with the same name already exists. - - If the policy is `REPLACE`, an existing entry will be replaced by the given entry. - - If the policy is `MERGE`: - - - If there is no entry with the same name, the new entry is inserted. - - If there is an entry with the same name: - - - If both entries are files, the old file is replaced by the given entry. - - If both entries are directories, a merge is performed as if using merge(). - - Otherwize the insertion fails (two entries with different types). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - - Args: - entry: Entry to insert. - policy: Policy to use to resolve conflicts. - - Returns: - True if the entry was insert, False otherwise. - """ - ... - def merge( - self, other: "IFileTree", overwrites: bool = False - ) -> Union[Dict["FileTreeEntry", "FileTreeEntry"], int]: - """ - Merge the given tree with this tree, i.e., insert all entries - of the given tree into this tree. - - The tree must not be this tree or a parent entry of this tree. Files present in both tree - will be replaced by files in the given tree. After a merge, the source tree will be - empty but still attached to its parent. - - If `overwrites` is `True`, a map from overriden files to new files will be returned. - - Note that the merge process makes no distinction between files and directories - when merging: if a directory is present in this tree and a file from source - is in conflict with it, the tree will be removed and the file inserted; if a file - is in this tree and a directory from source is in conflict with it, the file will - be replaced with the directory. - - This method invalidates iterators to this tree, all the subtrees under this tree - present in the given path, and all the subtrees of the given source. - - Args: - other: Tree to merge. - overwrites: If True, a mapping from overriden files to new files will be returned. - - Returns: - If `overwrites` is True, a mapping from overriden files to new files, otherwise - the number of overwritten entries. - - Raises: - RuntimeError: If the merge failed. - """ - ... - def move( - self, - entry: "FileTreeEntry", - path: str, - policy: "IFileTree.InsertPolicy" = InsertPolicy.FAIL_IF_EXISTS, - ) -> bool: - """ - Move the given entry to the given path under this tree. - - The entry must not be a parent tree of this tree. This method can also be used - to rename entries. - - If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry - at the same location already exists. If the policy is REPLACE, an existing - entry will be replaced. If MERGE, the entry will be merged with the existing - one (if the entry is a file, and a file exists, the file will be replaced). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - - Args: - entry: Entry to move. - path: The path to move the entry to. If the path ends with / or \\, the entry will be inserted in the corresponding directory instead of replacing it. If the - given path is empty (`""`), this is equivalent to `insert()`. - policy: Policy to use to resolve conflicts. - - Returns: - True if the entry was moved correctly, False otherwise. - """ - ... - def pathTo(self, entry: "FileTreeEntry", sep: str = "\\") -> str: - """ - Retrieve the path from this tree to the given entry. - - Args: - entry: The entry to reach, must be in this tree. - sep: The type of separator to use to create the path. - - Returns: - The path from this tree to the given entry, including the name of the entry, or - an empty string if the given entry was not found under this tree. - """ - ... - @overload - def remove(self, name: str) -> bool: - """ - Delete the entry with the given name. - - This method does not recurse into subtrees, so the entry should be - accessible directly from this tree. - - Args: - name: Name of the entry to delete. - - Returns: - True if the entry was deleted, False otherwise. - """ - ... - @overload - def remove(self, entry: "FileTreeEntry") -> bool: - """ - Delete the given entry. - - Args: - entry: Entry to delete. The entry must belongs to this tree (and not to a subtree). - - Returns: - True if the entry was deleted, False otherwise. - """ - ... - def removeAll(self, names: List[str]) -> int: - """ - Delete the entries with the given names from the tree. - - This method does not recurse into subtrees, so only entries accessible - directly from this tree will be removed. This method invalidates iterators. - - Args: - names: Names of the entries to delete. - - Returns: - The number of deleted entry. - """ - ... - def removeIf(self, filter: Callable[["FileTreeEntry"], bool]) -> int: - """ - Delete entries matching the given predicate from the tree. - - This method does not recurse into subtrees, so only entries accessible - directly from this tree will be removed. This method invalidates iterators. - - Args: - filter: Predicate that should return true for entries to delete. - - Returns: - The number of deleted entry. - """ - ... - def walk( - self, - callback: Callable[[str, "FileTreeEntry"], "IFileTree.WalkReturn"], - sep: str = "\\", - ): - """ - Walk this tree, calling the given function for each entry in it. - - The given callback will be called with two parameters: the path from this tree to the given entry - (with a trailing separator, not including the entry name), and the actual entry. The method returns - a `WalkReturn` object to indicates what to do. - - Args: - callback: Method to call for each entry in the tree. - sep: Type of separator to use to construct the path. - """ - ... - -class IInstallationManager: - def createFile(self, entry: "FileTreeEntry") -> str: - """ - Create a new file on the disk corresponding to the given entry. - - This method can be used by installer that needs to create files that are not in the original - archive. At the end of the installation, if there are entries in the final tree that were used - to create files, the corresponding files will be moved to the mod folder. - - Temporary files corresponding to created files are automatically cleaned up at the end of - the installation. - - Args: - entry: The entry for which a temporary file should be created. - - Returns: - The path to the created file, or an empty string if the file could not be created. - """ - ... - def extractFile(self, entry: "FileTreeEntry", silent: bool = False) -> str: - """ - Extract the specified file from the currently opened archive to a temporary - location. - - This method cannot be used to extract directory. - - The call will fail with an exception if no archive is open (plugins deriving from - IPluginInstallerSimple can rely on that, custom installers should not). The temporary - file is automatically cleaned up after the installation. This call can be very slow - if the archive is large and "solid". - - Args: - entry: Entry corresponding to the file to extract. - silent: If true, the dialog showing extraction progress will not be shown. - - Returns: - The absolute path to the temporary file, or an empty string if the file was not extracted. - """ - ... - def extractFiles( - self, entries: List["FileTreeEntry"], silent: bool = False - ) -> List[str]: - """ - Extract the specified files from the currently opened archive to a temporary - location. - - This method cannot be used to extract directories. - - The call will fail with an exception if no archive is open (plugins deriving from - IPluginInstallerSimple can rely on that, custom installers should not). The temporary - files are automatically cleaned up after the installation. This call can be very slow - if the archive is large and "solid". - - Args: - entries: Entries corresponding to the files to extract. - silent: If true, the dialog showing extraction progress will not be shown. - - Returns: - A list containing absolute paths to the temporary files. - """ - ... - def getSupportedExtensions(self) -> List[str]: - """ - Returns: - The extensions of archives supported by this installation manager. - """ - ... - def installArchive( - self, mod_name: "GuessedString", archive: str, mod_id: int - ) -> "InstallResult": - """ - Install the given archive. - - Args: - mod_name: Suggested name of the mod. - archive: Path to the archive to install. - mod_id: ID of the mod, if available. - - Returns: - The result of the installation. - """ - ... - def setURL(self, url: str): - """ - Set the url associated with the mod being installed. - - Args: - url: Url to set. - """ - ... - -class IModInterface: - def absolutePath(self) -> str: - """ - Returns: - Absolute path to the mod to be used in file system operations. - """ - ... - def addCategory(self, name: str): - """ - Assign a category to the mod. If the named category does not exist it is created. - - Args: - name: Name of the new category to assign. - """ - ... - def addNexusCategory(self, category_id: int): - """ - Set the category id from a nexus category id. Conversion to MO ID happens internally. - - If a mapping is not possible, the category is set to the default value. - - Args: - category_id: The Nexus category ID. - """ - ... - def categories(self) -> List[str]: - """ - Returns: - The list of categories assigned to this mod. - """ - ... - def name(self) -> str: - """ - Returns: - The name of this mod. - """ - ... - def remove(self) -> bool: - """ - Delete the mod from the disc. - - This does not update the global ModInfo structure or indices. - - Returns: - True if the mod was deleted, False otherwise. - """ - ... - def removeCategory(self, name: str) -> bool: - """ - Unassign a category from this mod. - - Args: - name: Name of the category to remove. - - Returns: - True if the category was removed, False otherwise (e.g. if no such category - was assigned). - """ - ... - def setGameName(self, name: str): - """ - Set the source game of this mod. - - Args: - name: The new source game short name of this mod. - """ - ... - def setIsEndorsed(self, endorsed: bool): - """ - Set endorsement state of the mod. - - Args: - endorsed: New endorsement state of this mod. - """ - ... - def setName(self, name: str) -> bool: - """ - Set the name of this mod. - - This will also update the name of the directory that contains this mod - - Args: - name: New name for this mod. - - Returns: - True if the name was changed, False if an error occured (e.g. if the name is not a valid - directory name). - """ - ... - def setNewestVersion(self, version: "VersionInfo"): - """ - Set the latest known version of this mod. - - Args: - version: The latest known version of this mod. - """ - ... - def setNexusID(self, nexus_id: int): - """ - Set the Nexus ID of this mod. - - Args: - nexus_id: Thew new Nexus ID of this mod. - """ - ... - def setVersion(self, version: "VersionInfo"): - """ - Set the version of this mod. - - Args: - version: The new version of this mod. - """ - ... - -class IModList: - """ - Interface to the mod-list. - - All api functions in this interface work need the internal name of a mod to find a - mod. For regular mods (mods the user installed) the display name (as shown to the user) - and internal name are identical. For other mods (non-MO mods) there is currently no way - to translate from display name to internal name because the display name might not me un-ambiguous. - """ - - def allMods(self) -> List[str]: - """ - Returns: - A list containing the internal names of all installed mods. - """ - ... - def displayName(self, name: str) -> str: - """ - Retrieve the display name of a mod from its internal name. - - If you received an internal name from the API (e.g. `IPluginList.origin`) then you should use - that name to identify the mod in all other api calls but use this function to retrieve the name - to show to the user. - - Args: - name: Internal name of the mod. - - Returns: - The display name of the given mod. - """ - ... - def onModMoved(self, callback: Callable[[str, int, int], None]) -> bool: - """ - Install a handler to be called when a mod is moved. - - Args: - callback: The function to call when a mod is moved. The first argument is the internal name of the mod, the second argument the old priority and the third argument the new priority. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onModStateChanged(self, callback: Callable[[str, int], None]) -> bool: - """ - Install a handler to be called when a mod state changes (enabled/disabled, endorsed, ...). - - Args: - callback: The function to call when the state of a mod changes. The first argument is the internal mod name, and the second one the new state of the mod. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def priority(self, name: str) -> int: - """ - Retrieve the priority of a mod. - - Args: - name: Internal name of the mod. - - Returns: - The priority of the given mod. - """ - ... - def setActive(self, name: str, active: bool) -> bool: - """ - Enable or disable a mod. - - Calling this will cause MO to re-evaluate its virtual file system so this is - a fairly expensive call. - - Args: - name: Internal name of the mod to enable or disable. - active: True to enable the mod, False to disable it. - - Returns: - True on success, False otherwise. - """ - ... - def setPriority(self, name: str, priority: int) -> bool: - """ - Change the priority of a mod. - - `priority` is the new priority after the move. Keep in mind that the mod disappears from its - old location and all mods with higher priority than the moved mod decrease in priority by one. - - Args: - name: Internal name of the mod. - priority: The new priority of the mod. - - Returns: - True if the priority was changed, False otherwise (if the name or priority were invalid). - """ - ... - def state(self, name: str) -> int: - """ - Retrieve the state of a mod. - - Args: - name: Internal name of the mod. - - Returns: - The state of the given mod. - """ - ... - -class IModRepositoryBridge(PyQt5.QtCore.QObject): - descriptionAvailable: PyQt5.QtCore.pyqtSignal = ... - filesAvailable: PyQt5.QtCore.pyqtSignal = ... - fileInfoAvailable: PyQt5.QtCore.pyqtSignal = ... - downloadURLsAvailable: PyQt5.QtCore.pyqtSignal = ... - endorsementsAvailable: PyQt5.QtCore.pyqtSignal = ... - endorsementToggled: PyQt5.QtCore.pyqtSignal = ... - trackedModsAvailable: PyQt5.QtCore.pyqtSignal = ... - trackingToggled: PyQt5.QtCore.pyqtSignal = ... - requestFailed: PyQt5.QtCore.pyqtSignal = ... - def _object(self) -> PyQt5.QtCore.QObject: - """ - Returns: - The underlying `QObject` for the bridge. - """ - ... - def requestDescription(self, game_name: str, mod_id: int, user_data: MoVariant): - """ - Request description of a mod. - - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - user_data: User data to be returned with the result. - """ - ... - def requestDownloadURL( - self, game_name: str, mod_id: int, file_id: int, user_data: MoVariant - ): - """ - Request download URL for mod file.0 - - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - file_id: ID of the file for which a URL should be returned. - user_data: User data to be returned with the result. - """ - ... - def requestFileInfo( - self, game_name: str, mod_id: int, file_id: int, user_data: MoVariant - ): - """ - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - file_id: ID of the file for which information is requested. - user_data: User data to be returned with the result. - """ - ... - def requestFiles(self, game_name: str, mod_id: int, user_data: MoVariant): - """ - Request the list of files belonging to a mod. - - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - user_data: User data to be returned with the result. - """ - ... - def requestToggleEndorsement( - self, - game_name: str, - mod_id: int, - mod_version: str, - endorse: bool, - user_data: MoVariant, - ): - """ - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - mod_version: Version of the mod. - endorse: - user_data: User data to be returned with the result. - """ - ... - -class IOrganizer: - """ - Interface to class that provides information about the running session - of Mod Organizer to be used by plugins. - """ - - def appVersion(self) -> "VersionInfo": - """ - Returns: - The running version of Mod Organizer. - """ - ... - def basePath(self) -> str: - """ - Returns: - The absolute path to the base directory of Mod Organizer. - """ - ... - def createMod(self, name: "GuessedString") -> "IModInterface": - """ - Create a new mod with the specified name. - - If a mod with the same name already exists, the user will be queried. If the user chooses - to merge or replace, the call will succeed, otheriwse the call will fail. - - Args: - name: Name of the mod to create. - - Returns: - An interface to the newly created mod that can be used to modify it, or `None` if the mod - could not be created. - """ - ... - def createNexusBridge(self) -> "IModRepositoryBridge": - """ - Create a new Nexus interface. - - Returns: - The newly created Nexus interface. - """ - ... - def downloadManager(self) -> "IDownloadManager": - """ - Returns: - The interface to the download manager. - """ - ... - def downloadsPath(self) -> str: - """ - Returns: - The absolute path to the download directory. - """ - ... - def findFileInfos( - self, path: str, filter: Callable[["FileInfo"], bool] - ) -> List["FileInfo"]: - """ - Find files in the virtual directory matching the specified filter. - - Args: - path: The path to search in (relative to the 'data' folder). - filter: The function to use to filter files. Should return True for the files to keep. - - Returns: - The list of `QFileInfo` corresponding to the matching files. - """ - ... - @overload - def findFiles(self, path: str, filter: Callable[[str], bool]) -> List[str]: - """ - Find files in the given folder that matches the given filter. - - Args: - path: The path to search in (relative to the 'data' folder). - filter: The function to use to filter files. Should return True for the files to keep. - - Returns: - The list of matching files. - """ - ... - @overload - def findFiles(self, path: str, patterns: List[str]) -> List[str]: - """ - Find files in the given folder that matches one of the given glob patterns. - - Args: - path: The path to search in (relative to the 'data' folder). - patterns: List of glob patterns to match against. - - Returns: - The list of matching files. - """ - ... - @overload - def findFiles(self, path: str, pattern: str) -> List[str]: - """ - Find files in the given folder that matches the given glob pattern. - - Args: - path: The path to search in (relative to the 'data' folder). - pattern: The glob pattern to use to filter files. - - Returns: - The list of matching files. - """ - ... - def getFileOrigins(self, filename: str) -> List[str]: - """ - Retrieve the file origins for the speicified file. - - The origins are listed with their internal name. The internal name of a mod can differ - from the display name for disambiguation. - - Args: - filename: Path to the file to retrieve origins for (relative to the 'data' folder). - - Returns: - The list of origins that contain the specified file, sorted by their priority. - """ - ... - def getGame(self, name: str) -> "IPluginGame": - """ - Retrieve the game plugin matching the given name. - - Args: - name: Name of the game (short name). - - Returns: - The plugin for the given game, or `None` if none was found. - """ - ... - def getMod(self, name: str) -> "IModInterface": - """ - Retrieve an interface to a mod using its name. - - Args: - name: Name of the mod to retrieve. - - Returns: - An interface to the given mod, or `None` if there is no mod with this name - """ - ... - def installMod(self, filename: str, name_suggestion: str = "") -> "IModInterface": - """ - Install a mod archive at the specified location. - - Args: - filename: Absolute filepath to the archive to install. - name_suggestion: Suggested name for this mod. This can still be changed by the user. - - Returns: - An interface to the new installed mod, or `None` if no installation took place (canceled or failure). - """ - ... - def listDirectories(self, directory: str) -> List[str]: - """ - Retrieve the list of (virtual) subdirectories in the given path. - - Args: - directory: Path to the directory to list (relative to the 'data' folder). - - Returns: - The list of directories in the given directory. - """ - ... - def managedGame(self) -> "IPluginGame": - """ - Returns: - The plugin corresponding to the current game. - """ - ... - def modDataChanged(self, mod: "IModInterface"): - """ - Notify the organizer that the given mod has changed. - - Args: - mod: The mod that has changed. - """ - ... - def modList(self) -> "IModList": - """ - Returns: - The interface to the mod list. - """ - ... - def modsPath(self) -> str: - """ - Returns: - The (absolute) path to the mods directory. - """ - ... - def modsSortedByProfilePriority(self) -> List[str]: - """ - Returns: - The list of mod (names), sorted according to the current profile priorities. - """ - ... - def onAboutToRun(self, callback: Callable[[str], bool]) -> bool: - """ - Install a new handler to be called when an application is about to run. - - Multiple handlers can be installed. If any of the handler returns `False`, the application will - not run. - - Args: - callback: The function to call when an application is about to run. The parameter is the absolute path to the application to run. The function can return False to prevent the application from running. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onFinishedRun(self, callback: Callable[[str, int], None]) -> bool: - """ - Install a new handler to be called when an application has finished running. - - Args: - callback: The function to call when an application has finished running. The first parameter is the absolute path to the application, and the second parameter is the exit code of the application. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onModInstalled(self, callback: Callable[[str], None]) -> bool: - """ - Install a new handler to be called when a new mod is installed. - - Args: - callback: The function to call when a mod is installed. The parameter of the function is the name of the installed mod. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onPluginSettingChanged( - self, callback: Callable[[str, str, MoVariant, MoVariant], None] - ) -> bool: - """ - Install a new handler to be called when a plugin setting is changed. - - Args: - callback: The function to call when a plugin setting is changed. The parameters are: The name of the plugin, the name of the setting, the old value (or `None` if the setting did not exist before) and the new value - of the setting (or `None` if the setting has been removed). - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onProfileChanged( - self, callback: Callable[["IProfile", "IProfile"], None] - ) -> bool: - """ - Install a new handler to be called when the current profile is changed. - - The function is called when the profile is changed but some operations related to - the profile might not be finished when this is called (e.g., the virtual file system - might not be up-to-date). - - Args: - callback: The function to call when the current profile is changed. The first parameter is the old profile (can be `None`, e.g. at startup), and the second parameter is the new profile (cannot be `None`). - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onUserInterfaceInitialized( - self, callback: Callable[[PyQt5.QtWidgets.QMainWindow], None] - ) -> bool: - """ - Install a new handler to be called when the UI has been fully initialized. - - Args: - callback: The function to call when the user-interface has been fully initialized. The parameter is the main window of the application (`QMainWindow`). - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def overwritePath(self) -> str: - """ - Returns: - The (absolute) path to the overwrite directory. - """ - ... - def persistent( - self, plugin_name: str, key: str, default: MoVariant = None - ) -> MoVariant: - """ - Retrieve the specified persistent value for a plugin. - - A persistent is an arbitrary value that the plugin can set and retrieve that is persistently stored - by the main application. There is no UI for the user to change this value but they can directly access - the storage - - Args: - plugin_name: Name of the plugin for which to retrieve the value. This should always be IPlugin::name() unless you have a really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - default: Default value to return if the key is not set (yet). - - Returns: - The value corresponding to the given persistent setting, or `def` is the key is not found. - """ - ... - def pluginDataPath(self) -> str: - """ - Retrieve the path to a directory where plugin data should be stored. - - For python plugins, it is recommended to use a dedicated folder (per plugin) if you need to - store data (resources, or multiple python files). - - Returns: - Path to a directory where plugin data should be stored. - """ - ... - def pluginList(self) -> "IPluginList": - """ - Returns: - The plugin list interface. - """ - ... - def pluginSetting(self, plugin_name: str, key: str) -> MoVariant: - """ - Retrieve settings of plugins. - - Args: - plugin_name: Name of the plugin to retrieve the setting for. - key: Name of the setting to retrieve the value for. - - Returns: - The value of the setting. - """ - ... - def profile(self) -> "IProfile": - """ - Returns: - The interface to the current profile. - """ - ... - def profileName(self) -> str: - """ - Returns: - The name of the current profile, or an empty string if no profile has been loaded (yet). - """ - ... - def profilePath(self) -> str: - """ - Returns: - The absolute path to the active profile or an empty string if no profile has been loaded (yet). - """ - ... - def refreshModList(self, save_changes: bool = True): - """ - Refresh the mod list. - - Args: - save_changes: If True, the relevant profile information is saved first (enabled mods and order of mods). - """ - ... - def removeMod(self, mod: "IModInterface") -> bool: - """ - Remove a mod (from disc and from the UI). - - Args: - mod: The mod to remove. - - Returns: - True if the mod was removed, False otherwise. - """ - ... - def resolvePath(self, filename: str) -> str: - """ - Resolves a path relative to the virtual data directory to its absolute real path. - - Args: - filename: Path to resolve. - - Returns: - The absolute real path, or an empty string if the path was not found. - """ - ... - def setPersistent( - self, plugin_name: str, key: str, value: MoVariant, sync: bool = True - ): - """ - Set the specified persistent value for a plugin. - - This does not update the in-memory value for this setting, see `setPluginSetting()` for this. - - Args: - plugin_name: Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - value: New value for the setting. - sync: If True, the storage is immediately written to disc. This costs performance but is safer against data loss. - """ - ... - def setPluginSetting(self, plugin_name: str, key: str, value: MoVariant): - """ - Set the specified setting for a plugin. - - This automatically notify handlers register with `onPluginSettingChanged`, so you do not have to do it yourself. - - Args: - plugin_name: Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - value: New value for the setting. - """ - ... - def startApplication( - self, - executable: str, - args: List[str] = [], - cwd: str = "", - profile: str = "", - forcedCustomOverwrite: str = "", - ignoreCustomOverwrite: bool = False, - ) -> int: - """ - Starts an application with virtual filesystem active. - - Args: - executable: Name or path of the executable. If this is only a filename, it will only work if it has been configured in MO as an executable. If it is a relative path it is expected to be relative to the game directory. - args: Arguments to pass to the executable. If the list is empty, and `executable` refers to a configured executable, the configured arguments are used. - cwd: The working directory for the executable. If this is empty, the path to the executable is used unless `executable` referred to a configured MO executable, in which case the configured cwd is used. - profile: Profile to use. If this is empty (the default) the current profile is used. - forcedCustomOverwrite: The mod to set as the custom overwrite, regardless of what the profile has configured. - ignoreCustomOverwrite: Set to true to ignore the profile's configured custom overwrite. - - Returns: - The handle to the started application, or 0 if the application failed to start. - """ - ... - def waitForApplication(self, handle: int) -> Tuple[bool, int]: - """ - Wait for the application corresponding to the given handle to finish. - - This will always show the lock overlay, regardless of whether the - user has disabled locking in the setting, so use this with care. - Note that the lock overlay will always allow the user to unlock, in - which case this will return False. - - Args: - handle: Handle of the application to wait for (as returned by `startApplication()`). - - Returns: - A tuple `(result, exitcode)`, where `result` is a boolean indicating if the application - completed successfully, and `exitcode` is the exit code of the application. - """ - ... - -class IPlugin(abc.ABC): - """ - Base class for all plugins. - """ - - def __init__(self): ... - @abc.abstractmethod - def author(self) -> str: - """ - Returns: - The name of the plugin author. - """ - ... - @abc.abstractmethod - def description(self) -> str: - """ - Returns: - The description for this plugin. - """ - ... - @abc.abstractmethod - def init(self, organizer: "IOrganizer") -> bool: - """ - Initialize this plugin. - - Args: - organizer: The main organizer interface. - - Returns: - True if the plugin was initialized correctly, False otherwise. - """ - ... - @abc.abstractmethod - def isActive(self) -> bool: - """ - Check if this plugin is active. - - It is possible to use a plugin setting (specified in `settings()`) here to allow - users to manually enable/disable a plugin. - - Returns: - True if this plugin is active, False otherwise. - """ - ... - @abc.abstractmethod - def name(self) -> str: - """ - Retrieve the name of the plugin. - - The name of the plugin is used for internal storage purpose so it should not change, - and it should be static. In particular, you should not use a localized string (`tr()`) - for the plugin name. - - In the future, we will provide a way to localized plugin names using a distinct method, - such as `localizedName()`. - - Returns: - The name of the plugin. - """ - ... - @abc.abstractmethod - def settings(self) -> List["PluginSetting"]: - """ - Returns: - A list of settings for this plugin. - """ - ... - @abc.abstractmethod - def version(self) -> "VersionInfo": - """ - Returns: - The version of this plugin. - """ - ... - -class IPluginDiagnose(IPlugin): - """ - Plugins that create problem reports to be displayed in the UI. - - This can be used to report problems related to the same plugin (which implements further - interfaces) or as a stand-alone diagnosis tool. - """ - - def __init__(self): ... - def _invalidate(self): - """ - Invalidate the problems corresponding to this plugin. - """ - ... - @abc.abstractmethod - def activeProblems(self) -> List[int]: - """ - Retrieve the list of active problems found by this plugin. - - This method returns a list of problem IDs, that are then used when calling other methods - such as `shortDescription()` or `hasGuidedFix()`. - - Returns: - The list of active problems for this plugin. - """ - ... - @abc.abstractmethod - def fullDescription(self, key: int) -> str: - """ - Retrieve the full description of the problem corresponding to the given key. - - Args: - key: ID of the problem. - - Returns: - The full description of the problem. - - Raises: - IndexError: If the key is not valid. - """ - ... - @abc.abstractmethod - def hasGuidedFix(self, key: int) -> bool: - """ - Check if the problem corresponding to the given key has a guided fix. - - Args: - key: ID of the problem. - - Returns: - True if there is a guided fix for the problem, False otherwise. - - Raises: - IndexError: If the key is not valid. - """ - ... - @abc.abstractmethod - def shortDescription(self, key: int) -> str: - """ - Retrieve the short description of the problem corresponding to the given key. - - Args: - key: ID of the problem. - - Returns: - The short description of the problem. - - Raises: - IndexError: If the key is not valid. - """ - ... - @abc.abstractmethod - def startGuidedFix(self, key: int): - """ - Starts a guided fix for the problem corresponding to the given key. - - This method should throw `ValueError` if there is no guided fix for the corresponding - problem. - - Args: - key: ID of the problem. - - Raises: - IndexError: If the key is not valid. - ValueError: If there is no guided fix for this problem. - """ - ... - -class IPluginFileMapper(IPlugin): - """ - Plugins that adds virtual file links. - """ - - def __init__(self): ... - @abc.abstractmethod - def mappings(self) -> List["Mapping"]: - """ - Returns: - Mapping for the virtual file system (VFS). - """ - ... - -class IPluginGame(IPlugin): - """ - Base classes for game plugins. - - Each game requires a specific game plugin. These plugins were initially designed for - Bethesda games, so a lot of methods and attributes are irrelevant for other games. If - you wish to write a plugin for a much simpler game, please consider the `basic_games` - plugin: https://github.com/ModOrganizer2/modorganizer-basic_games - """ - - def __init__(self): ... - @abc.abstractmethod - def CCPlugins(self) -> List[str]: - """ - Returns: - The current list of active Creation Club plugins. - """ - ... - @abc.abstractmethod - def DLCPlugins(self) -> List[str]: - """ - Returns: - The list of esp/esm files that are part of known DLCs. - """ - ... - @abc.abstractmethod - def binaryName(self) -> str: - """ - Returns: - The name of the default executable to run (relative to the game folder). - """ - ... - @abc.abstractmethod - def dataDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The name of the directory containing data (relative to the game folder). - """ - ... - @abc.abstractmethod - def documentsDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The directory of the documents folder where configuration files and such for this game reside. - """ - ... - @abc.abstractmethod - def executableForcedLoads(self) -> List["ExecutableForcedLoadSetting"]: - """ - Returns: - A list of automatically discovered libraries that can be force loaded with executables. - """ - ... - @abc.abstractmethod - def executables(self) -> List["ExecutableInfo"]: - """ - Returns: - A list of automatically discovered executables of the game itself and tools surrounding it. - """ - ... - def feature(self, feature_type: Type[GameFeatureType]) -> GameFeatureType: - """ - Retrieve a specified game feature from this plugin. - - Args: - feature_type: The class of feature to retrieve. - - Returns: - The game feature corresponding to the given type, or `None` if the feature is - not implemented. - """ - ... - def featureList(self) -> Dict[Type[GameFeatureType], GameFeatureType]: - """ - Retrieve the list of game features implemented for this plugin. - - Python plugin should not implement this method but `_featureList()`. - - Returns: - A mapping from feature type to actual game features. - """ - ... - @abc.abstractmethod - def gameDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The directory containing the game installation. - """ - ... - @abc.abstractmethod - def gameIcon(self) -> PyQt5.QtGui.QIcon: - """ - Returns: - The icon representing the game. - """ - ... - @abc.abstractmethod - def gameName(self) -> str: - """ - Returns: - The name of the game (as displayed to the user). - """ - ... - @abc.abstractmethod - def gameNexusName(self) -> str: - """ - Returns: - The name of the game identifier for Nexus. - """ - ... - @abc.abstractmethod - def gameShortName(self) -> str: - """ - Returns: - The short name of the game. - """ - ... - @abc.abstractmethod - def gameVariants(self) -> List[str]: - """ - Retrieve the list of variants for this game. - - If there are multiple variants of a game (and the variants make a difference to the - plugin), like a regular one and a GOTY-edition, the plugin can return a list of them - and the user gets to chose which one he owns. - - Returns: - The list of variants of the game. - """ - ... - @abc.abstractmethod - def gameVersion(self) -> str: - """ - Returns: - The version of the game. - """ - ... - @abc.abstractmethod - def getLauncherName(self) -> str: - """ - Returns: - The name of the launcher executable to run (relative to the game folder), or an - empty string if there is no launcher. - """ - ... - @abc.abstractmethod - def iniFiles(self) -> List[str]: - """ - Returns: - The list of INI files this game uses. The first file in the list should be the - 'main' INI file. - """ - ... - @abc.abstractmethod - def initializeProfile(self, directory: PyQt5.QtCore.QDir, settings: int): - """ - Initialize a profile for this game. - - The MO app does not yet support virtualizing only specific aspects but plugins should be written - with this future functionality in mind. - - This function will be used to initially create a profile, potentially to repair it or upgrade/downgrade - it so the implementations have to gracefully handle the case that the directory already contains files. - - Args: - directory: The directory where the profile is to be initialized. - settings: The parameters for how the profile should be initialized. - """ - ... - @abc.abstractmethod - def isInstalled(self) -> bool: - """ - Returns: - True if this game has been discovered as installed, False otherwise. - """ - ... - @abc.abstractmethod - def loadOrderMechanism(self) -> "LoadOrderMechanism": - """ - Returns: - The load order mechanism used by this game. - """ - ... - @abc.abstractmethod - def looksValid(self, directory: PyQt5.QtCore.QDir) -> bool: - """ - Check if the given directory looks like a valid game installation. - - Args: - directory: Directory to check. - - Returns: - True if the directory looks like a valid installation of this game, False otherwise. - """ - ... - @abc.abstractmethod - def nexusGameID(self) -> int: - """ - Retrieve the Nexus game ID for this game. - - Example: For Skyrim, the Nexus game ID is 110. - - Returns: - The Nexus game ID for this game. - """ - ... - @abc.abstractmethod - def nexusModOrganizerID(self) -> int: - """ - Retrieve the Nexus mod ID of Mod Organizer for this game. - - Example: For Skyrim SE, the mod ID of MO2 is 6194. You can find the mod ID in the URL: - https://www.nexusmods.com/skyrimspecialedition/mods/6194 - - Returns: - The Nexus mod ID of Mod Organizer for this game. - """ - ... - @abc.abstractmethod - def primaryPlugins(self) -> List[str]: - """ - Returns: - The list of plugins that are part of the game and not considered optional. - """ - ... - @abc.abstractmethod - def primarySources(self) -> List[str]: - """ - Retrieve primary alternative 'short' names for this game. - - This is used to determine if a Nexus (or other) download source should be considered - as a primary source for the game so that it is not flagged as an alternative one. - - Returns: - The list of primary alternative 'short' names for this game, or an empty list. - """ - ... - @abc.abstractmethod - def savegameExtension(self) -> str: - """ - Returns: - The file extension of save games for this game. - """ - ... - @abc.abstractmethod - def savegameSEExtension(self) -> str: - """ - Returns: - The file extension of Script Extender saves for this game. - """ - ... - @abc.abstractmethod - def savesDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The directory where save games are stored. - """ - ... - @abc.abstractmethod - def setGamePath(self, path: str): - """ - Set the path to the managed game. - - This is called during instance creation if the game is not auto-detected and the user has - to specify the installation location. This is not called if the game has been auto-detected, - so `isInstalled()` should call this. - - Args: - path: Path to the game installation. - """ - ... - @abc.abstractmethod - def setGameVariant(self, variant: str): - """ - Set the game variant. - - If there are multiple variants of game (as returned by `gameVariants()`), this will be - called on start with the user-selected game variant. - - Args: - variant: The game variant selected by the user. - """ - ... - @abc.abstractmethod - def sortMechanism(self) -> "SortMechanism": - """ - Returns: - The sort mechanism for this game. - """ - ... - @abc.abstractmethod - def steamAPPId(self) -> str: - """ - Retrieve the Steam app ID for this game. - - If the game is not available on Steam, this should return an empty string. - - If a game is available in multiple versions, those might have different app ids. The plugin - should try to return the right one - - Returns: - The Steam app ID for this game. Should be empty for games not available on steam. - """ - ... - @abc.abstractmethod - def validShortNames(self) -> List[str]: - """ - Retrieve the valid 'short' names for this game. - - This is used to determine if a Nexus download is valid for the current game since not all - game variants have their own nexus pages and others can handle downloads from other nexus - game pages and should be allowed to do so (e.g., you can install some Skyrim LE mod even - when using Skyrim SE). - - The short name should be considered the primary handler for a directly supported game - for puroses of auto-launching an instance. - - Returns: - The list of valid short names for this game. - """ - ... - -class IPluginInstaller(IPlugin): - """ - This is the top-level class for installer. Actual installers should inherit either: - - - `IPluginInstallerSimple` if the installer can work directly with the archive. This is what - most installers use. - - `IPluginInstallerCustom` if the installer needs to perform custom operations. This is only - used by the external NCC installer and the OMOD installer. - """ - - @abc.abstractmethod - def isArchiveSupported(self, tree: "IFileTree") -> bool: - """ - Check if the given file tree corresponds to a supported archive for this installer. - - Args: - tree: The tree representing the content of the archive. - - Returns: - True if this installer can handle the archive, False otherwise. - """ - ... - @abc.abstractmethod - def isManualInstaller(self) -> bool: - """ - Check if this installer is a manual installer. - - Returns: - True if this installer is a manual installer, False otherwise. - """ - ... - @abc.abstractmethod - def priority(self) -> int: - """ - Retrieve the priority of this installer. - - If multiple installers are able to handle an archive, the one with the highest priority wins. - - Returns: - The priority of this installer. - """ - ... - def setInstallationManager(self, manager: "IInstallationManager"): - """ - Set the installation manager for this installer. - - Python plugins usually do not need to re-implement this and can directly access the installation - manager using `_manager()`. - - Args: - manager: The installation manager. - """ - ... - def setParentWidget(self, parent: PyQt5.QtWidgets.QWidget): - """ - Set the parent widget for this installer. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - - Args: - parent: The parent widget. - """ - ... - -class IPluginInstallerCustom(IPluginInstaller): - """ - Custom installer for mods. Custom installers receive the archive name and have to go - from there. They have to be able to extract the archive themself. - - Example of such installers are the external NCC installer or the OMOD installer. - """ - - def __init__(self): ... - def _manager(self) -> "IInstallationManager": - """ - Returns: - The installation manager. - """ - ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def install( - self, - mod_name: "GuessedString", - game_name: str, - archive_name: str, - version: str, - nexus_id: int, - ) -> "InstallResult": - """ - Install the given archive. - - The mod needs to be created by calling `IOrganizer.createMod` first. - - Args: - mod_name: Name of the mod to install. As an input parameter this is the suggested name (e.g. from meta data) The installer may change this parameter to rename the mod). - game_name: Name of the game for which the mod is installed. - archive_name: Name of the archive to install. - version: Version of the mod. May be empty if the version is not yet known. The plugin is responsible for setting the version on the created mod. - nexus_id: ID of the mod or -1 if unknown. The plugin is responsible for setting the mod ID for the created mod. - - Returns: - The result of the installation process. - """ - ... - @overload - @abc.abstractmethod - def isArchiveSupported(self, tree: "IFileTree") -> bool: - """ - Check if the given file tree corresponds to a supported archive for this installer. - - Args: - tree: The tree representing the content of the archive. - - Returns: - True if this installer can handle the archive, False otherwise. - """ - ... - @overload - @abc.abstractmethod - def isArchiveSupported(self, archive_name: str) -> bool: - """ - Check if the given file is a supported archive for this installer. - - Args: - archive_name: Name of the archive. - - Returns: - True if this installer can handle the archive, False otherwise. - """ - ... - @abc.abstractmethod - def supportedExtensions(self) -> List[str]: - """ - Returns: - A list of file extensions that this installer can handle. - """ - ... - -class IPluginInstallerSimple(IPluginInstaller): - """ - Simple installer for mods. Simple installers only deal with an in-memory structure - representing the archive and can modify what to install and where by editing this structure. - Actually extracting the archive is handled by the manager. - """ - - def __init__(self): ... - def _manager(self) -> "IInstallationManager": - """ - Returns: - The installation manager. - """ - ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def install( - self, name: "GuessedString", tree: "IFileTree", version: str, nexus_id: int - ) -> Union[ - "InstallResult", "IFileTree", Tuple["InstallResult", "IFileTree", str, int] - ]: - """ - Install a mod from an archive filetree. - - The installer can modify the given tree and use the manager to extract or create new - files. - - This method returns different type of objects depending on the actual result of the - installation. The C++ bindings for this method always returns a tuple (result, tree, - version, id). - - Args: - name: Name of the mod to install. As an input parameter this is the suggested name (e.g. from meta data) The installer may change this parameter to rename the mod). - tree: In-memory representation of the archive content. - version: Version of the mod, or an empty string is unknown. - nexus_id: ID of the mod, or -1 if unknown. - - Returns: - In case of failure, the result of the installation, otherwise the modified tree or - a tuple (result, tree, version, id) containing the result of the installation, the - modified tree, the new version and the new ID. The tuple can be returned even if the - installation did not succeed. - """ - ... - -class IPluginList: - """ - Primary interface to the list of plugins. - """ - - def isMaster(self, name: str) -> bool: - """ - Check if a plugin is a master file (basically a library, referenced by other plugins). - - In gamebryo games, a master file will usually have a .esm file extension but technically - an esp can be flagged as master and an esm might not be. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - True if the given plugin is a master plugin, False otherwise or if the file does not exist. - """ - ... - def loadOrder(self, name: str) -> int: - """ - Retrieve the load order of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The load order of the plugin (the order in which the game loads it). If all plugins are enabled this - is the same as the priority but disabled plugins will have a load order of -1. This also returns -1 - if the plugin does not exist. - """ - ... - def masters(self, name: str) -> List[str]: - """ - Retrieve the list of masters required for a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The list of masters for the plugin (filenames with extension, no path). - """ - ... - def onPluginMoved(self, callback: Callable[[str, int, int], None]) -> bool: - """ - Install a new handler to be called when a plugin is moved. - - Args: - callback: The function to call when a plugin is moved. The first parameter is the plugin name, the second the old priority of the plugin and the third one the new priority. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onRefreshed(self, callback: Callable[[None], None]) -> bool: - """ - Install a new handler to be called when the list of plugins is refreshed. - - Args: - callback: The function to call when the list of plugins is refreshed. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def origin(self, name: str) -> str: - """ - Retrieve the origin of a plugin. This is either the (internal) name of a mod, `"overwrite"` or `"data"`. - - The internal name of a mod can differ from the display name for disambiguation. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The name of the origin of the plugin, or an empty string if the plugin does not exist. - """ - ... - def pluginNames(self) -> List[str]: - """ - Returns: - The list of all plugin names. - """ - ... - def priority(self, name: str) -> int: - """ - Retrieve the priority of a plugin. - - The higher the priority, the more important. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The priority of the given plugin, or -1 if the plugin does not exist. - """ - ... - def setLoadOrder(self, loadorder: List[str]): - """ - Set the load order. - - Plugins not included in the list will be placed at highest priority in the order they - were before. - - Args: - loadorder: The new load order, specified by the list of plugin names, sorted. - """ - ... - def setState(self, name: str, state: int): - """ - Set the state of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - state: New state of the plugin (`INACTIVE` or `ACTIVE`). - """ - ... - def state(self, name: str) -> int: - """ - Retrieve the state of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The state of the plugin. - """ - ... - -class IPluginModPage(IPlugin): - def __init__(self): ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def displayName(self) -> str: - """ - Returns: - The name of the page as displayed in the UI. - """ - ... - @abc.abstractmethod - def handlesDownload( - self, - page_url: PyQt5.QtCore.QUrl, - download_url: PyQt5.QtCore.QUrl, - fileinfo: "ModRepositoryFileInfo", - ) -> bool: - """ - Check if the plugin handles the specified download. - - Args: - page_url: URL of the page that contains the download link. - download_url: The download URL. - fileinfo: Not usable in python. - - Returns: - True if this plugin wants to handle the specified download, False otherwise. - """ - ... - @abc.abstractmethod - def icon(self) -> PyQt5.QtGui.QIcon: - """ - Returns: - The icon to display with the page. - """ - ... - @abc.abstractmethod - def pageURL(self) -> PyQt5.QtCore.QUrl: - """ - Returns: - The URL to open when the user wants to visit this mod page. - """ - ... - def setParentWidget(self, parent: PyQt5.QtWidgets.QWidget): - """ - Set the parent widget for this mod page. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - - Args: - parent: The parent widget. - """ - ... - @abc.abstractmethod - def useIntegratedBrowser(self) -> bool: - """ - Indicates if the page should be displayed in the integrated browser. - - Unless the page provides a special means of starting downloads (like the nxm:// url schema - on nexus), it will not be possible to handle downloads unless the integrated browser is used! - - Returns: - True if the page should be opened in the integrated browser, False otherwise. - """ - ... - -class IPluginPreview(IPlugin): - """ - These plugins add support for previewing files in the data pane. Right now all image formats supported - by qt are implemented (including dds) but no audio files and no 3d mesh formats. - """ - - def __init__(self): ... - @abc.abstractmethod - def genFilePreview( - self, filename: str, max_size: PyQt5.QtCore.QSize - ) -> PyQt5.QtWidgets.QWidget: - """ - Generate a preview for the specified file. - - Args: - filename: Path to the file to preview. - max_size: Maximum size of the generated widget. - - Returns: - The widget showing a preview of the file. - """ - ... - @abc.abstractmethod - def supportedExtensions(self) -> List[str]: - """ - Returns: - The list of file extensions that are supported by this preview plugin. - """ - ... - -class IPluginTool(IPlugin): - """ - This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools submenu - and get invoked when the user clicks it. They are expected to have a user interface of some sort. These - are almost like independent applications except they can access all Mod Organizer interfaces like querying - and modifying the current profile, mod list, load order, use MO to install mods and so on. A tool plugin - can (and should!) integrate its UI as a window inside MO and thus doesn't have to initialize a windows - application itself. - """ - - def __init__(self): ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def display(self): - """ - Called when the user starts the tool. - """ - ... - @abc.abstractmethod - def displayName(self) -> str: - """ - Returns: - The display name for this tool, as shown in the tool menu. - """ - ... - @abc.abstractmethod - def icon(self) -> PyQt5.QtGui.QIcon: - """ - Returns: - The icon for this tool, or a default-constructed QICon(). - """ - ... - def setParentWidget(self, parent: PyQt5.QtWidgets.QWidget): - """ - Set the parent widget for this tool. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - - Args: - parent: The parent widget. - """ - ... - @abc.abstractmethod - def tooltip(self) -> str: - """ - Returns: - The tooltip for this tool. - """ - ... - -class IProfile: - def absolutePath(self) -> str: ... - def invalidationActive(self) -> Tuple[bool, bool]: ... - def localSavesEnabled(self) -> bool: ... - def localSettingsEnabled(self) -> bool: ... - def name(self) -> str: ... - -class ISaveGame: - """ - Base class for information about what is in a save game. - """ - - def __init__(self): ... - def allFiles(self) -> List[str]: - """ - Returns: - The list of all files related to this save. - """ - ... - def getCreationTime(self) -> PyQt5.QtCore.QDateTime: - """ - Retrieve the creation time of the save. - - The creation time of a save is not always the same as the creation time of - the file containing the save. - - Returns: - The creation time of the save. - """ - ... - def getFilename(self) -> str: - """ - Returns: - The name of the (main) save file. - """ - ... - def getSaveGroupIdentifier(self) -> str: - """ - Retrieve the name of the group this files belong to. - - The name can be used to identify sets of saves to transfer between profiles. For - RPG games, this is usually the name of a character. - - Returns: - The group identifier for this save game. - """ - ... - def hasScriptExtenderFile(self) -> bool: - """ - Returns: - True if this save game has an associated script extender save, False otherwise. - """ - ... - -class ISaveGameInfoWidget(PyQt5.QtWidgets.QWidget): - """ - Base class for a save game info widget. - """ - - def __init__(self, parent: PyQt5.QtWidgets.QWidget = None): - """ - Args: - parent: Parent widget. - """ - ... - def _widget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The underlying `QWidget`. - """ - ... - @abc.abstractmethod - def setSave(self, save: str): - """ - Set the save file to display in this widget. - - Args: - save: Path to the save file. - """ - ... - -class LocalSavegames(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def mappings(self, profile_save_dir: PyQt5.QtCore.QDir) -> List["Mapping"]: ... - @abc.abstractmethod - def prepareProfile(self, profile: "IProfile") -> bool: ... - -class Mapping: - @property - def createTarget(self) -> bool: ... - @createTarget.setter - def createTarget(self, arg0: bool): ... - @property - def destination(self) -> str: ... - @destination.setter - def destination(self, arg0: str): ... - @property - def isDirectory(self) -> bool: ... - @isDirectory.setter - def isDirectory(self, arg0: bool): ... - @property - def source(self) -> str: ... - @source.setter - def source(self, arg0: str): ... - def __init__(self): - """ - Creates an empty Mapping. - """ - ... - -class ModDataChecker(abc.ABC): - """ - Game feature that is used to check the content of a data tree. - """ - - class CheckReturn(Enum): - INVALID = ... - FIXABLE = ... - VALID = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - FIXABLE: "ModDataChecker.CheckReturn" = ... - INVALID: "ModDataChecker.CheckReturn" = ... - VALID: "ModDataChecker.CheckReturn" = ... - def __init__(self): ... - @abc.abstractmethod - def dataLooksValid(self, filetree: "IFileTree") -> "ModDataChecker.CheckReturn": - """ - Check that the given filetree represent a valid mod layout, or can be easily - fixed. - - This method is mainly used during installation (to find which installer should - be used or to recurse into multi-level archives), or to quickly indicates to a - user if a mod looks valid. - - This method does not have to be exact, it only has to indicate if the given tree - looks like a valid mod or not by quickly checking the structure (heavy operations - should be avoided). - - If the tree can be fixed by the `fix()` method, this method should return `FIXABLE`. - `FIXABLE` should only be returned when it is guaranteed that `fix()` can fix the tree. - - Args: - filetree: The tree starting at the root of the "data" folder. - - Returns: - Whether the tree is invalid, fixable or valid. - """ - ... - def fix(self, filetree: "IFileTree") -> Optional["IFileTree"]: - """ - Try to fix the given tree. - - This method is used during installation to try to fix invalid archives and will only be - called if dataLooksValid returned `FIXABLE`. - - Args: - filetree: The tree to try to fix. Can be modified during the process. - - Returns: - The fixed tree, or a null pointer if the tree could not be fixed. - """ - ... - -class ModDataContent(abc.ABC): - """ - The ModDataContent feature is used (when available) to indicate to users the content - of mods in the "Content" column. - - The feature exposes a list of possible content types, each associated with an ID, a name - and an icon. The icon is the path to either: - - - A Qt resource or; - - A file on the disk. - - In order to facilitate the implementation, MO2 already provides a set of icons that can - be used. Those icons are all under ``:/MO/gui/content`` (e.g. ``:/MO/gui/content/plugin`` or ``:/MO/gui/content/music`` `). - - The list of available icons is: - - - ``plugin``: |plugin-icon| - - ``skyproc``: |skyproc-icon| - - ``texture``: |texture-icon| - - ``music``: |music-icon| - - ``sound``: |sound-icon| - - ``interface``: |interface-icon| - - ``skse``: |skse-icon| - - ``script``: |script-icon| - - ``mesh``: |mesh-icon| - - ``string``: |string-icon| - - ``bsa``: |bsa-icon| - - ``menu``: |menu-icon| - - ``inifile``: |inifile-icon| - - ``modgroup``: |modgroup-icon| - - .. |plugin-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/jigsaw-piece.png - .. |skyproc-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/hand-of-god.png - .. |texture-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/empty-chessboard.png - .. |music-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/double-quaver.png - .. |sound-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/lyre.png - .. |interface-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/usable.png - .. |skse-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/checkbox-tree.png - .. |script-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/tinker.png - .. |mesh-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/breastplate.png - .. |string-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/conversation.png - .. |bsa-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/locked-chest.png - .. |menu-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/config.png - .. |inifile-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/feather-and-scroll.png - .. |modgroup-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/xedit.png - """ - - class Content: - @property - def icon(self) -> str: ... - @property - def id(self) -> int: ... - @property - def name(self) -> str: ... - def __init__(self, id: int, name: str, icon: str, filter_only: bool = False): - """ - Args: - id: ID of this content. - name: Name of this content. - icon: Path to the icon for this content. Can be either a path to an image on the disk, or to a resource. Can be an empty string if filterOnly - is true. - filter_only: Indicates if the content should only be show in the filter criteria and not in the actual Content column. - """ - ... - def isOnlyForFilter(self) -> bool: - """ - Returns: - True if this content is only meant to be used as a filter criteria. - """ - ... - def __init__(self): ... - @abc.abstractmethod - def getAllContents(self) -> List["ModDataContent.Content"]: - """ - Returns: - The list of all possible contents for the corresponding game. - """ - ... - @abc.abstractmethod - def getContentsFor(self, filetree: "IFileTree") -> List[int]: - """ - Retrieve the list of contents in the given tree. - - Args: - filetree: The tree corresponding to the mod to retrieve contents for. - - Returns: - The IDs of the content in the given tree. - """ - ... - -class ModRepositoryFileInfo: - @property - def categoryID(self) -> int: ... - @categoryID.setter - def categoryID(self, arg0: int): ... - @property - def description(self) -> str: ... - @description.setter - def description(self, arg0: str): ... - @property - def fileCategory(self) -> int: ... - @fileCategory.setter - def fileCategory(self, arg0: int): ... - @property - def fileID(self) -> int: ... - @fileID.setter - def fileID(self, arg0: int): ... - @property - def fileName(self) -> str: ... - @fileName.setter - def fileName(self, arg0: str): ... - @property - def fileSize(self) -> int: ... - @fileSize.setter - def fileSize(self, arg0: int): ... - @property - def fileTime(self) -> PyQt5.QtCore.QDateTime: ... - @fileTime.setter - def fileTime(self, arg0: PyQt5.QtCore.QDateTime): ... - @property - def gameName(self) -> str: ... - @gameName.setter - def gameName(self, arg0: str): ... - @property - def modID(self) -> int: ... - @modID.setter - def modID(self, arg0: int): ... - @property - def modName(self) -> str: ... - @modName.setter - def modName(self, arg0: str): ... - @property - def name(self) -> str: ... - @name.setter - def name(self, arg0: str): ... - @property - def newestVersion(self) -> "VersionInfo": ... - @newestVersion.setter - def newestVersion(self, arg0: "VersionInfo"): ... - @property - def repository(self) -> str: ... - @repository.setter - def repository(self, arg0: str): ... - @property - def uri(self) -> str: ... - @uri.setter - def uri(self, arg0: str): ... - @property - def userData(self) -> MoVariant: ... - @userData.setter - def userData(self, arg0: MoVariant): ... - @property - def version(self) -> "VersionInfo": ... - @version.setter - def version(self, arg0: "VersionInfo"): ... - @overload - def __init__(self, other: "ModRepositoryFileInfo"): ... - @overload - def __init__( - self, game_name: str = None, mod_id: int = None, file_id: int = None - ): ... - def __str__(self) -> str: ... - @staticmethod - def createFromJson(data: str) -> "ModRepositoryFileInfo": ... - -class PluginSetting: - """ - Class to hold the user-configurable parameters a plugin accepts. The purpose of this class is - only to inform the application what settings to offer to the user, it does not hold the actual value. - """ - - @property - def default_value(self) -> MoVariant: ... - @default_value.setter - def default_value(self, arg0: MoVariant): ... - @property - def description(self) -> str: ... - @description.setter - def description(self, arg0: str): ... - @property - def key(self) -> str: ... - @key.setter - def key(self, arg0: str): ... - def __init__(self, key: str, description: str, default_value: MoVariant): - """ - Args: - key: Name of the setting. - description: Description of the setting. - default_value: Default value of the setting. - """ - ... - -class SaveGameInfo(abc.ABC): - """ - Feature to get hold of stuff to do with save games. - """ - - def __init__(self): ... - @abc.abstractmethod - def getMissingAssets(self, filepath: str) -> Dict[str, List[str]]: - """ - Retrieve missing assets from the save. - - Args: - filepath: Path to the save file. - - Returns: - A collection of missing assets and the modules that can supply those assets. - """ - ... - @abc.abstractmethod - def getSaveGameInfo(self, filepath: str) -> "ISaveGame": - """ - Retrieve the information about the supplied save game. - - Args: - filepath: Path to the save file. - - Returns: - A SaveGame corresponding to the given save file. - """ - ... - @abc.abstractmethod - def getSaveGameWidget( - self, parent: PyQt5.QtWidgets.QWidget - ) -> Optional["ISaveGameInfoWidget"]: - """ - Retrieve a widget to display over the save game list. - - This method is allowed to return `None` in case no widget has been implemented. - - Args: - parent: The parent widget. - - Returns: - A SaveGameInfoWidget to display information about save game. - """ - ... - @abc.abstractmethod - def hasScriptExtenderSave(self, filepath: str) -> bool: - """ - Check whether or not the save has a paired script extender save. - - Args: - filepath: Path to the save file. - - Returns: - True if the given save file has a paired script extender save, False otherwise. - """ - ... - -class ScriptExtender(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def BinaryName(self) -> str: - """ - Returns: - The name of the script extender binary. - """ - ... - @abc.abstractmethod - def PluginPath(self) -> str: - """ - Returns: - The script extender plugin path, relative to the data folder. - """ - ... - @abc.abstractmethod - def getArch(self) -> int: - """ - Returns: - The CPU platform of the extender. - """ - ... - @abc.abstractmethod - def getExtenderVersion(self) -> str: - """ - Returns: - The version of the script extender. - """ - ... - @abc.abstractmethod - def isInstalled(self) -> bool: - """ - Returns: - True if the script extender is installed, False otherwise. - """ - ... - @abc.abstractmethod - def loaderName(self) -> str: - """ - Returns: - The loader to use to ensure the game runs with the script extender. - """ - ... - @abc.abstractmethod - def loaderPath(self) -> str: - """ - Returns: - The fullpath to the script extender loader. - """ - ... - @abc.abstractmethod - def saveGameAttachmentExtensions(self) -> List[str]: - """ - Returns: - Additional savegame attachments. - """ - ... - -class UnmanagedMods(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def displayName(self, mod_name: str) -> str: - """ - Retrieve the display name of a given mod. - - Args: - mod_name: Internal name of the mod. - - Returns: - The display name of the mod. - """ - ... - @abc.abstractmethod - def mods(self, official_only: bool) -> List[str]: - """ - Retrieve the list of unmanaged mods for the corresponding game. - - Args: - official_only: Retrieve only unmanaged official mods. - - Returns: - The list of unmanaged mods (internal names). - """ - ... - @abc.abstractmethod - def referenceFile(self, mod_name: str) -> PyQt5.QtCore.QFileInfo: - """ - Retrieve the reference file for the requested mod. - - Example: For Bethesda games, the reference file may be the main - plugin (esp or esm) for the game or a DLCs. - - Args: - mod_name: Internal name of the mod. - - Returns: - The reference file (absolute path) for the requested mod. - """ - ... - @abc.abstractmethod - def secondaryFiles(self, mod_name: str) -> List[str]: - """ - Retrieve the secondary files for the requested mod. - - Example: For Bethesda games, the secondary files may be the archives - corresponding to the reference file. - - Args: - mod_name: Internal name of the mod. - - Returns: - The secondary files (absolute paths) for the request mod. - """ - ... - -class VersionInfo: - """ - Represents the version of a mod or plugin. - """ - - @overload - def __init__(self): - """ - Construct an invalid VersionInfo. - """ - ... - @overload - def __init__(self, value: str, scheme: "VersionScheme" = VersionScheme.DISCOVER): - """ - Construct a VersionInfo by parsing the given string according to the given scheme. - - Args: - value: String to parse. - scheme: Scheme to use to parse the string. - """ - ... - @overload - def __init__( - self, - major: int, - minor: int, - subminor: int, - subsubminor: int, - release_type: "ReleaseType" = ReleaseType.FINAL, - ): - """ - Construct a VersionInfo using the given elements. - - Args: - major: Major version. - minor: Minor version. - subminor: Subminor version. - subsubminor: Subsubminor version. - release_type: Type of release. - """ - ... - @overload - def __init__( - self, - major: int, - minor: int, - subminor: int, - release_type: "ReleaseType" = ReleaseType.FINAL, - ): - """ - Construct a VersionInfo using the given elements. - - Args: - major: Major version. - minor: Minor version. - subminor: Subminor version. - release_type: Type of release. - """ - ... - @overload - def __eq__(self, arg2: "VersionInfo") -> bool: ... - @overload - def __eq__(self, other: object) -> bool: ... - def __ge__(self, arg2: "VersionInfo") -> bool: ... - def __gt__(self, arg2: "VersionInfo") -> bool: ... - def __le__(self, arg2: "VersionInfo") -> bool: ... - def __lt__(self, arg2: "VersionInfo") -> bool: ... - @overload - def __ne__(self, arg2: "VersionInfo") -> bool: ... - @overload - def __ne__(self, other: object) -> bool: ... - def __str__(self) -> str: - """ - Returns: - See `canonicalString()`. - """ - ... - def canonicalString(self) -> str: - """ - Returns: - A canonical string representing this version, that can be stored and then parsed using the parse() method. - """ - ... - def clear(self): - """ - Resets this VersionInfo to an invalid version. - """ - ... - def displayString(self, forced_segments: int = 2) -> str: - """ - Args: - forced_segments: The number of version segments to display even if the version is 0. 1 is major, 2 is major and minor, etc. The only implemented ranges are (-inf,2] for major/minor, [3] for major/minor/subminor, - and [4,inf) for major/minor/subminor/subsubminor. This only versions with a regular scheme. - - Returns: - A string for display to the user. The returned string may not contain enough information to reconstruct this version info. - """ - ... - def isValid(self) -> bool: - """ - Returns: - True if this VersionInfo is valid, False otherwise. - """ - ... - def parse( - self, - value: str, - scheme: "VersionScheme" = VersionScheme.DISCOVER, - manual_input: bool = False, - ): - """ - Update this VersionInfo by parsing the given string using the given scheme. - - Args: - value: String to parse. - scheme: Scheme to use to parse the string. - manual_input: True if the given string should be treated as user input. - """ - ... - def scheme(self) -> "VersionScheme": - """ - Returns: - The version scheme in effect for this VersionInfo. - """ - ... diff --git a/stubs/2.4.0/mobase.pyi b/stubs/2.4.0/mobase.pyi deleted file mode 100644 index f72d230..0000000 --- a/stubs/2.4.0/mobase.pyi +++ /dev/null @@ -1,3782 +0,0 @@ -__version__ = "2.4.0.alpha1" - -import abc -from enum import Enum -from typing import ( - Dict, - Iterator, - List, - Tuple, - Union, - Any, - Optional, - Callable, - overload, - TypeVar, - Type, -) -import PyQt5.QtCore -import PyQt5.QtGui -import PyQt5.QtWidgets - -MoVariant = Union[None, bool, int, str, List[Any], Dict[str, Any]] -GameFeatureType = TypeVar("GameFeatureType") - -class InterfaceNotImplemented: ... - -def getFileVersion(filepath: str) -> str: - """ - Retrieve the file version of the given executable. - - Args: - filepath: Absolute path to the executable. - - Returns: - The file version, or an empty string if the file version could not be retrieved. - """ - ... - -def getIconForExecutable(executable: str) -> PyQt5.QtGui.QIcon: - """ - Retrieve the icon of an executable. Currently this always extracts the biggest icon. - - Args: - executable: Absolute path to the executable. - - Returns: - The icon for this executable, if any. - """ - ... - -def getProductVersion(executable: str) -> str: - """ - Retrieve the product version of the given executable. - - Args: - executable: Absolute path to the executable. - - Returns: - The product version, or an empty string if the product version could not be retrieved. - """ - ... - -class EndorsedState(Enum): - ENDORSED_FALSE = ... - ENDORSED_TRUE = ... - ENDORSED_UNKNOWN = ... - ENDORSED_NEVER = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class GuessQuality(Enum): - """ - Describes how good the code considers a guess (i.e. for a mod name) this is used to - determine if a name from another source should overwrite or not. - """ - - INVALID = ... - FALLBACK = ... - GOOD = ... - META = ... - PRESET = ... - USER = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class InstallResult(Enum): - SUCCESS = ... - FAILED = ... - CANCELED = ... - MANUAL_REQUESTED = ... - NOT_ATTEMPTED = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class LoadOrderMechanism(Enum): - FILE_TIME = ... - PLUGINS_TXT = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class ModState(Enum): - EXISTS = ... - ACTIVE = ... - ESSENTIAL = ... - EMPTY = ... - ENDORSED = ... - VALID = ... - ALTERNATE = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class PluginState(Enum): - MISSING = ... - INACTIVE = ... - ACTIVE = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class ProfileSetting(Enum): - MODS = ... - CONFIGURATION = ... - SAVEGAMES = ... - PREFER_DEFAULTS = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class ReleaseType(Enum): - PRE_ALPHA = ... - ALPHA = ... - BETA = ... - CANDIDATE = ... - FINAL = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class SortMechanism(Enum): - NONE = ... - MLOX = ... - BOSS = ... - LOOT = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class TrackedState(Enum): - TRACKED_FALSE = ... - TRACKED_TRUE = ... - TRACKED_UNKNOWN = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class VersionScheme(Enum): - DISCOVER = ... - REGULAR = ... - DECIMAL_MARK = ... - NUMBERS_AND_LETTERS = ... - DATE = ... - LITERAL = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class BSAInvalidation(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def activate(self, profile: "IProfile"): ... - @abc.abstractmethod - def deactivate(self, profile: "IProfile"): ... - @abc.abstractmethod - def isInvalidationBSA(self, name: str) -> bool: ... - -class DataArchives(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def addArchive(self, profile: "IProfile", index: int, name: str): - """ - Add an archive to the archive list. - - Args: - profile: Profile to add the archive to. - index: Index to insert before. Use 0 for the beginning of the list or INT_MAX for - the end of the list). - name: Name of the archive to add. - """ - ... - @abc.abstractmethod - def archives(self, profile: "IProfile") -> List[str]: - """ - Retrieve the list of archives in the given profile. - - Args: - profile: Profile to retrieve archives from. - - Returns: - The list of archives in the given profile. - """ - ... - @abc.abstractmethod - def removeArchive(self, profile: "IProfile", name: str): - """ - Remove the given archive from the given profile. - - Args: - profile: Profile to remove the archive from. - name: Name of the archive to remove. - """ - ... - @abc.abstractmethod - def vanillaArchives(self) -> List[str]: - """ - Retrieve the list of vanilla archives. - - Vanilla archives are archive files that are shipped with the original - game. - - Returns: - The list of vanilla archives. - """ - ... - -class ExecutableForcedLoadSetting: - def __init__(self, process: str, library: str): ... - def enabled(self) -> bool: ... - def forced(self) -> bool: ... - def library(self) -> str: ... - def process(self) -> str: ... - def withEnabled(self, enabled: bool) -> "ExecutableForcedLoadSetting": ... - def withForced(self, forced: bool) -> "ExecutableForcedLoadSetting": ... - -class ExecutableInfo: - def __init__(self, title: str, binary: PyQt5.QtCore.QFileInfo): ... - def arguments(self) -> List[str]: ... - def asCustom(self) -> "ExecutableInfo": ... - def binary(self) -> PyQt5.QtCore.QFileInfo: ... - def isCustom(self) -> bool: ... - def isValid(self) -> bool: ... - def steamAppID(self) -> str: ... - def title(self) -> str: ... - def withArgument(self, argument: str) -> "ExecutableInfo": ... - def withSteamAppId(self, app_id: str) -> "ExecutableInfo": ... - def withWorkingDirectory( - self, directory: PyQt5.QtCore.QDir - ) -> "ExecutableInfo": ... - def workingDirectory(self) -> PyQt5.QtCore.QDir: ... - -class FileInfo: - """ - Information about a virtualised file - """ - - @property - def archive(self) -> str: ... - @archive.setter - def archive(self, arg0: str): ... - @property - def filePath(self) -> str: ... - @filePath.setter - def filePath(self, arg0: str): ... - @property - def origins(self) -> List[str]: ... - @origins.setter - def origins(self, arg0: List[str]): ... - def __init__(self): - """ - Creates an uninitialized FileInfo. - """ - ... - -class FileTreeEntry: - """ - Represent an entry in a file tree, either a file or a directory. This class - inherited by IFileTree so that operations on entry are the same for a file or - a directory. - - This class provides convenience methods to query information on the file, like its - name or the its last modification time. It also provides a convenience astree() method - that can be used to retrieve the tree corresponding to its entry in case the entry - represent a directory. - """ - - class FileTypes(Enum): - """ - Enumeration of the different file type or combinations. - """ - - DIRECTORY = ... - FILE = ... - FILE_OR_DIRECTORY = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - DIRECTORY: "FileTreeEntry.FileTypes" = ... - FILE: "FileTreeEntry.FileTypes" = ... - FILE_OR_DIRECTORY: "FileTreeEntry.FileTypes" = ... - @overload - def __eq__(self, arg2: str) -> bool: ... - @overload - def __eq__(self, arg2: "FileTreeEntry") -> bool: ... - @overload - def __eq__(self, other: object) -> bool: ... - def __repr__(self) -> str: ... - def detach(self) -> bool: - """ - Detach this entry from its parent tree. - - Returns: - True if the entry was removed correctly, False otherwize. - """ - ... - def fileType(self) -> "FileTreeEntry.FileTypes": - """ - Returns: - The filetype of this entry. - """ - ... - @overload - def hasSuffix(self, suffixes: List[str]) -> bool: - """ - Check if this entry has one of the given suffixes. - - Args: - suffixes: Suffixes to check. - - Returns: - True if this entry is a file and has one of the given suffix. - """ - ... - @overload - def hasSuffix(self, suffix: str) -> bool: - """ - Check if this entry has the given suffix. - - Args: - suffix: Suffix to check. - - Returns: - True if this entry is a file and has the given suffix. - """ - ... - def isDir(self) -> bool: - """ - Returns: - True if this entry is a directory, False otherwise. - """ - ... - def isFile(self) -> bool: - """ - Returns: - True if this entry is a file, False otherwise. - """ - ... - def moveTo(self, tree: "IFileTree") -> bool: - """ - Move this entry to the given tree. - - Args: - tree: The tree to move this entry to. - - Returns: - True if the entry was moved correctly, False otherwize. - """ - ... - def name(self) -> str: - """ - Returns: - The name of this entry. - """ - ... - def parent(self) -> Optional["IFileTree"]: - """ - Returns: - The parent tree containing this entry, or a `None` if this entry is the root - or the parent tree is unreachable. - """ - ... - def path(self, sep: str = "\\") -> str: - """ - Retrieve the path from this entry up to the root of the tree. - - This method propagate up the tree so is not constant complexity as - the full path is never stored. - - Args: - sep: The type of separator to use to create the path. - - Returns: - The path from this entry to the root, including the name of this entry. - """ - ... - def pathFrom(self, tree: "IFileTree", sep: str = "\\") -> str: - """ - Retrieve the path from the given tree to this entry. - - Args: - tree: The tree to reach, must be a parent of this entry. - sep: The type of separator to use to create the path. - - Returns: - The path from the given tree to this entry, including the name of this entry, or - an empty string if the given tree is not a parent of this entry. - """ - ... - def suffix(self) -> str: - """ - Retrieve the "last" extension of this entry. - - The "last" extension is everything after the last dot in the file name. - - Returns: - The last extension of this entry, or an empty string if the file has no extension - or is directory. - """ - ... - -class GamePlugins(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def getLoadOrder(self) -> List[str]: ... - @abc.abstractmethod - def lightPluginsAreSupported(self) -> bool: - """ - Returns: - True if light plugins are supported, False otherwise. - """ - ... - @abc.abstractmethod - def readPluginLists(self, plugin_list: "IPluginList"): ... - @abc.abstractmethod - def writePluginLists(self, plugin_list: "IPluginList"): ... - -class GuessedString: - """ - Represents a string that may be set from different places. Each time the value is - changed a "quality" is specified to say how probable it is the value is the best choice. - Only the best choice should be used in the end but alternatives can be queried. This - class also allows a filter to be set. If a "guess" doesn't pass the filter, it is ignored. - """ - - @overload - def __init__(self): - """ - Creates a GuessedString with no associated value. - """ - ... - @overload - def __init__(self, value: str, quality: "GuessQuality"): - """ - Creates a GuessedString with the given value and quality. - - Args: - value: Initial value of the GuessedString. - quality: Quality of the initial value. - """ - ... - def __str__(self) -> str: ... - @overload - def reset(self) -> "GuessedString": - """ - Reset this GuessedString to an invalid state. - - Returns: - This GuessedString object. - """ - ... - @overload - def reset(self, value: str, quality: "GuessQuality") -> "GuessedString": - """ - Reset this GuessedString object with the given value and quality, only - if the given quality is better than the current one. - - Args: - value: New value for this GuessedString. - quality: Quality of the new value. - - Returns: - This GuessedString object. - """ - ... - @overload - def reset(self, other: "GuessedString") -> "GuessedString": - """ - Reset this GuessedString object by copying the given one, only - if the given one has better quality. - - Args: - other: The GuessedString to copy. - - Returns: - This GuessedString object. - """ - ... - def setFilter(self, filter: Callable[[str], Union[str, bool]]): - """ - Set the filter for this GuessedString. - - The filter is applied on every `update()` and can reject the new value - altogether or modify it (by returning a new value). - - Args: - filter: The new filter. - """ - ... - @overload - def update(self, value: str) -> "GuessedString": - """ - Update this GuessedString by adding the given value to the list of variants - and setting the actual value without changing the current quality of this - GuessedString. - - The GuessedString is only updated if the given value passes the filter. - - Args: - value: The new value for this string. - - Returns: - This GuessedString object. - """ - ... - @overload - def update(self, value: str, quality: "GuessQuality") -> "GuessedString": - """ - Update this GuessedString by adding a new variants with the given quality. - - If the specified quality is better than the current one, the actual value of - the GuessedString is also updated. - - The GuessedString is only updated if the given value passes the filter. - - Args: - value: The new variant to add. - quality: The quality of the variant. - - Returns: - This GuessedString object. - """ - ... - def variants(self) -> List[str]: - """ - Returns: - The list of variants for this GuessedString. - """ - ... - -class IDownloadManager(PyQt5.QtCore.QObject): - downloadComplete: PyQt5.QtCore.pyqtSignal = ... - downloadPaused: PyQt5.QtCore.pyqtSignal = ... - downloadFailed: PyQt5.QtCore.pyqtSignal = ... - downloadRemoved: PyQt5.QtCore.pyqtSignal = ... - def _object(self) -> PyQt5.QtCore.QObject: - """ - Returns: - The underlying `QObject` for the manager. - """ - ... - def downloadPath(self, id: int) -> str: - """ - Retrieve the (absolute) path of the specified download. - - Args: - id: ID of the download. - - Returns: - The absolute path to the file corresponding to the given download. This file - may not exist yet if the download is incomplete. - """ - ... - def startDownloadNexusFile(self, mod_id: int, file_id: int) -> int: - """ - Download a file from www.nexusmods.com/. is always the game - currently being managed. - - Args: - mod_id: ID of the mod to download the file from. - file_id: ID of the file to download. - - Returns: - An ID identifying the download. - """ - ... - def startDownloadURLs(self, urls: List[str]) -> int: - """ - Download a file by url. - - The list can contain alternative URLs to allow the download manager to switch - in case of download problems - - Args: - urls: List of urls to download from. - - Returns: - An ID identifying the download. - """ - ... - -class IFileTree(FileTreeEntry): - """ - Interface to classes that provides way to visualize and alter file trees. The tree - may not correspond to an actual file tree on the disk (e.g., inside an archive, - from a QTree Widget, ...). - - Read-only operations on the tree are thread-safe, even when the tree has not been populated - yet. - - In order to prevent wrong usage of the tree, implementing classes may throw - UnsupportedOperationException if an operation is not supported. By default, all operations - are supported, but some may not make sense in many situations. - - The goal of this is not reflect the change made to a IFileTree to the disk, but child - classes may override relevant methods to do so. - - The tree is built upon FileTreeEntry. A given tree holds shared pointers to its entries - while each entry holds a weak pointer to its parent, this means that the descending link - are strong (shared pointers) but the uplink are weaks. - - Accessing the parent is always done by locking the weak pointer so that returned pointer - or either null or valid. This structure implies that as long as the initial root lives, - entry should not be destroyed, unless the entry are detached from the root and no shared - pointers are kept. - - However, it is not guarantee that one can go up the tree from a single node entry. If the - root node is destroyed, it will not be possible to go up the tree, even if we still have - a valid shared pointer. - """ - - class InsertPolicy(Enum): - FAIL_IF_EXISTS = ... - REPLACE = ... - MERGE = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - class WalkReturn(Enum): - """ - Enumeration that can be returned by the callback for the `walk()` method to stop the - walking operation early. - """ - - CONTINUE = ... - STOP = ... - SKIP = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - CONTINUE: "IFileTree.WalkReturn" = ... - FAIL_IF_EXISTS: "IFileTree.InsertPolicy" = ... - MERGE: "IFileTree.InsertPolicy" = ... - REPLACE: "IFileTree.InsertPolicy" = ... - SKIP: "IFileTree.WalkReturn" = ... - STOP: "IFileTree.WalkReturn" = ... - def __bool__(self) -> bool: - """ - Returns: - True if this tree is not empty, False otherwise. - """ - ... - def __getitem__(self, index: int) -> "FileTreeEntry": - """ - Retrieve the entry at the given index in this tree. - - Args: - index: Index of the entry to retrieve, must be less than the size. - - Returns: - The entry at the given index. - - Raises: - IndexError: If the given index is not in range for this tree. - """ - ... - def __iter__(self) -> Iterator[FileTreeEntry]: - """ - Retrieves an iterator for entries directly under this tree. - - This method does not recurse into subtrees, see `walk()` for this. - - Returns: - An iterator object that can be used to iterate over entries in this tree. - """ - ... - def __len__(self) -> int: - """ - Returns: - The number of entries directly under this tree. - """ - ... - def addDirectory(self, path: str) -> "IFileTree": - """ - Create a new directory tree under this tree. - - This method will create missing folders in the given path and will - not fail if the directory already exists but will fail if the given - path contains "." or "..". - This method invalidates iterators to this tree and all the subtrees - present in the given path. - - Args: - path: Path to the directory to create. - - Returns: - An IFileTree corresponding to the created directory. - - Raises: - RuntimeError: If the directory could not be created. - """ - ... - def addFile(self, path: str, replace_if_exists: bool = False) -> "FileTreeEntry": - """ - Create a new file directly under this tree. - - This method will fail if the file already exists and `replace_if_exists` is `False`. - This method invalidates iterators to this tree and all the subtrees present in the - given path. - - Args: - path: Path to the file to create. - replace_if_exists: If True and an entry already exists at the given location, it will be replaced by - a new entry. This will replace both files and directories. - - Returns: - A FileTreeEntry corresponding to the created file. - - Raises: - RuntimeError: If the file could not be created. - """ - ... - def clear(self) -> bool: - """ - Delete (detach) all the entries from this tree. - - This method will go through the entries in this tree and stop at the first - entry that cannot be deleted, this means that the tree can be partially cleared. - - Returns: - True if all entries have been detached, False otherwise. - """ - ... - def copy( - self, - entry: "FileTreeEntry", - path: str = "", - policy: "IFileTree.InsertPolicy" = InsertPolicy.FAIL_IF_EXISTS, - ) -> "FileTreeEntry": - """ - Move the given entry to the given path under this tree. - - The entry must not be a parent tree of this tree. This method can also be used - to rename entries. - - If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry - at the same location already exists. If the policy is REPLACE, an existing - entry will be replaced. If MERGE, the entry will be merged with the existing - one (if the entry is a file, and a file exists, the file will be replaced). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - - Args: - entry: Entry to copy. - path: The path to copy the entry to. If the path ends with / or \\, the entry will - be copied in the corresponding directory instead of replacing it. If the - given path is empty (`""`), the entry is copied directly under this tree. - policy: Policy to use to resolve conflicts. - - Returns: - The new entry (copy of the specified entry). - - Raises: - RuntimeError: If the entry could not be copied. - """ - ... - def createOrphanTree(self, name: str = "") -> "IFileTree": - """ - Create a new orphan empty tree. - - Args: - name: Name of the tree. - - Returns: - A new tree without any parent. - """ - ... - def exists( - self, - path: str, - type: "FileTreeEntry.FileTypes" = FileTreeEntry.FileTypes.FILE_OR_DIRECTORY, - ) -> bool: - """ - Check if the given entry exists. - - Args: - path: Path to the entry, separated by / or \\. - type: The type of the entry to check. - - Returns: - True if the entry was found, False otherwise. - """ - ... - def find( - self, - path: str, - type: "FileTreeEntry.FileTypes" = FileTreeEntry.FileTypes.FILE_OR_DIRECTORY, - ) -> Optional[Union["IFileTree", "FileTreeEntry"]]: - """ - Retrieve the given entry. - - If no entry exists at the given path, or if the entry is not of the right - type, `None` is returned. - - Args: - path: Path to the entry, separated by / or \\. - type: The type of the entry to check. - - Returns: - The entry at the given location, or `None` if the entry was not found or - was not of the correct type. - """ - ... - def insert( - self, - entry: "FileTreeEntry", - policy: "IFileTree.InsertPolicy" = InsertPolicy.FAIL_IF_EXISTS, - ) -> bool: - """ - Insert the given entry in this tree, removing it from its - previouis parent. - - The entry must not be this tree or a parent entry of this tree. - - - If the insert policy if `FAIL_IF_EXISTS`, the call will fail if an entry - with the same name already exists. - - If the policy is `REPLACE`, an existing entry will be replaced by the given entry. - - If the policy is `MERGE`: - - - If there is no entry with the same name, the new entry is inserted. - - If there is an entry with the same name: - - - If both entries are files, the old file is replaced by the given entry. - - If both entries are directories, a merge is performed as if using merge(). - - Otherwize the insertion fails (two entries with different types). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - - Args: - entry: Entry to insert. - policy: Policy to use to resolve conflicts. - - Returns: - True if the entry was insert, False otherwise. - """ - ... - def merge( - self, other: "IFileTree", overwrites: bool = False - ) -> Union[Dict["FileTreeEntry", "FileTreeEntry"], int]: - """ - Merge the given tree with this tree, i.e., insert all entries - of the given tree into this tree. - - The tree must not be this tree or a parent entry of this tree. Files present in both tree - will be replaced by files in the given tree. After a merge, the source tree will be - empty but still attached to its parent. - - If `overwrites` is `True`, a map from overriden files to new files will be returned. - - Note that the merge process makes no distinction between files and directories - when merging: if a directory is present in this tree and a file from source - is in conflict with it, the tree will be removed and the file inserted; if a file - is in this tree and a directory from source is in conflict with it, the file will - be replaced with the directory. - - This method invalidates iterators to this tree, all the subtrees under this tree - present in the given path, and all the subtrees of the given source. - - Args: - other: Tree to merge. - overwrites: If True, a mapping from overriden files to new files will be returned. - - Returns: - If `overwrites` is True, a mapping from overriden files to new files, otherwise - the number of overwritten entries. - - Raises: - RuntimeError: If the merge failed. - """ - ... - def move( - self, - entry: "FileTreeEntry", - path: str, - policy: "IFileTree.InsertPolicy" = InsertPolicy.FAIL_IF_EXISTS, - ) -> bool: - """ - Move the given entry to the given path under this tree. - - The entry must not be a parent tree of this tree. This method can also be used - to rename entries. - - If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry - at the same location already exists. If the policy is REPLACE, an existing - entry will be replaced. If MERGE, the entry will be merged with the existing - one (if the entry is a file, and a file exists, the file will be replaced). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - - Args: - entry: Entry to move. - path: The path to move the entry to. If the path ends with / or \\, the entry will - be inserted in the corresponding directory instead of replacing it. If the - given path is empty (`""`), this is equivalent to `insert()`. - policy: Policy to use to resolve conflicts. - - Returns: - True if the entry was moved correctly, False otherwise. - """ - ... - def pathTo(self, entry: "FileTreeEntry", sep: str = "\\") -> str: - """ - Retrieve the path from this tree to the given entry. - - Args: - entry: The entry to reach, must be in this tree. - sep: The type of separator to use to create the path. - - Returns: - The path from this tree to the given entry, including the name of the entry, or - an empty string if the given entry was not found under this tree. - """ - ... - @overload - def remove(self, name: str) -> bool: - """ - Delete the entry with the given name. - - This method does not recurse into subtrees, so the entry should be - accessible directly from this tree. - - Args: - name: Name of the entry to delete. - - Returns: - True if the entry was deleted, False otherwise. - """ - ... - @overload - def remove(self, entry: "FileTreeEntry") -> bool: - """ - Delete the given entry. - - Args: - entry: Entry to delete. The entry must belongs to this tree (and not to a subtree). - - Returns: - True if the entry was deleted, False otherwise. - """ - ... - def removeAll(self, names: List[str]) -> int: - """ - Delete the entries with the given names from the tree. - - This method does not recurse into subtrees, so only entries accessible - directly from this tree will be removed. This method invalidates iterators. - - Args: - names: Names of the entries to delete. - - Returns: - The number of deleted entry. - """ - ... - def removeIf(self, filter: Callable[["FileTreeEntry"], bool]) -> int: - """ - Delete entries matching the given predicate from the tree. - - This method does not recurse into subtrees, so only entries accessible - directly from this tree will be removed. This method invalidates iterators. - - Args: - filter: Predicate that should return true for entries to delete. - - Returns: - The number of deleted entry. - """ - ... - def walk( - self, - callback: Callable[[str, "FileTreeEntry"], "IFileTree.WalkReturn"], - sep: str = "\\", - ): - """ - Walk this tree, calling the given function for each entry in it. - - The given callback will be called with two parameters: the path from this tree to the given entry - (with a trailing separator, not including the entry name), and the actual entry. The method returns - a `WalkReturn` object to indicates what to do. - - Args: - callback: Method to call for each entry in the tree. - sep: Type of separator to use to construct the path. - """ - ... - -class IInstallationManager: - def createFile(self, entry: "FileTreeEntry") -> str: - """ - Create a new file on the disk corresponding to the given entry. - - This method can be used by installer that needs to create files that are not in the original - archive. At the end of the installation, if there are entries in the final tree that were used - to create files, the corresponding files will be moved to the mod folder. - - Temporary files corresponding to created files are automatically cleaned up at the end of - the installation. - - Args: - entry: The entry for which a temporary file should be created. - - Returns: - The path to the created file, or an empty string if the file could not be created. - """ - ... - def extractFile(self, entry: "FileTreeEntry", silent: bool = False) -> str: - """ - Extract the specified file from the currently opened archive to a temporary - location. - - This method cannot be used to extract directory. - - The call will fail with an exception if no archive is open (plugins deriving from - IPluginInstallerSimple can rely on that, custom installers should not). The temporary - file is automatically cleaned up after the installation. This call can be very slow - if the archive is large and "solid". - - Args: - entry: Entry corresponding to the file to extract. - silent: If true, the dialog showing extraction progress will not be shown. - - Returns: - The absolute path to the temporary file, or an empty string if the file was not extracted. - """ - ... - def extractFiles( - self, entries: List["FileTreeEntry"], silent: bool = False - ) -> List[str]: - """ - Extract the specified files from the currently opened archive to a temporary - location. - - This method cannot be used to extract directories. - - The call will fail with an exception if no archive is open (plugins deriving from - IPluginInstallerSimple can rely on that, custom installers should not). The temporary - files are automatically cleaned up after the installation. This call can be very slow - if the archive is large and "solid". - - Args: - entries: Entries corresponding to the files to extract. - silent: If true, the dialog showing extraction progress will not be shown. - - Returns: - A list containing absolute paths to the temporary files. - """ - ... - def getSupportedExtensions(self) -> List[str]: - """ - Returns: - The extensions of archives supported by this installation manager. - """ - ... - def installArchive( - self, mod_name: "GuessedString", archive: str, mod_id: int - ) -> "InstallResult": - """ - Install the given archive. - - Args: - mod_name: Suggested name of the mod. - archive: Path to the archive to install. - mod_id: ID of the mod, if available. - - Returns: - The result of the installation. - """ - ... - def setURL(self, url: str): - """ - Set the url associated with the mod being installed. - - Args: - url: Url to set. - """ - ... - -class IModInterface: - def absolutePath(self) -> str: - """ - Returns: - Absolute path to the mod to be used in file system operations. - """ - ... - def addCategory(self, name: str): - """ - Assign a category to the mod. If the named category does not exist it is created. - - Args: - name: Name of the new category to assign. - """ - ... - def addNexusCategory(self, category_id: int): - """ - Set the category id from a nexus category id. Conversion to MO ID happens internally. - - If a mapping is not possible, the category is set to the default value. - - Args: - category_id: The Nexus category ID. - """ - ... - def categories(self) -> List[str]: - """ - Returns: - The list of categories this mod belongs to. - """ - ... - def clearPluginSettings(self, plugin_name: str) -> Dict[str, MoVariant]: - """ - Remove all the settings of the specified plugin this mod. - - Args: - plugin_name: Name of the plugin for which settings should be removed. This should always be `IPlugin.name()` - unless you have a really good reason to access settings of another plugin. - - Returns: - The old settings from the given plugin, as returned by `pluginSettings()`. - """ - ... - def color(self) -> PyQt5.QtGui.QColor: - """ - Returns: - The color of the 'Notes' column chosen by the user. - """ - ... - def comments(self) -> str: - """ - Returns: - The comments for this mod, if any. - """ - ... - def converted(self) -> bool: - """ - Check if the mod was marked as converted by the user. - - When a mod is for a different game, a flag is shown to users to warn them, but - they can mark mods as converted to remove this flag. - - Returns: - True if this mod was marked as converted by the user. - """ - ... - def endorsedState(self) -> "EndorsedState": - """ - Returns: - The endorsement state of this mod. - """ - ... - def gameName(self) -> str: - """ - Retrieve the short name of the game associated with this mod. This may differ - from the current game plugin (e.g. you can install a Skyrim LE game in a SSE - installation). - - Returns: - The name of the game associated with this mod. - """ - ... - def ignoredVersion(self) -> "VersionInfo": - """ - Returns: - The ignored version of this mod (for update), or an invalid version if the user - did not ignore version for this mod. - """ - ... - def installationFile(self) -> str: - """ - Returns: - The absolute path to the file that was used to install this mod. - """ - ... - def name(self) -> str: - """ - Returns: - The name of this mod. - """ - ... - def newestVersion(self) -> "VersionInfo": - """ - Returns: - The newest version of thid mod (as known by MO2). If this matches version(), - then the mod is up-to-date. - """ - ... - def nexusId(self) -> int: - """ - Returns: - The Nexus ID of this mod. - """ - ... - def notes(self) -> str: - """ - Returns: - The notes for this mod, if any. - """ - ... - def pluginSetting( - self, plugin_name: str, key: str, default: MoVariant = None - ) -> MoVariant: - """ - Retrieve the specified setting in this mod for a plugin. - - Args: - plugin_name: Name of the plugin for which to retrieve a setting. This should always be `IPlugin.name()` - unless you have a really good reason to access settings of another plugin. - key: Identifier of the setting. - default: The default value to return if the setting does not exist. - - Returns: - The setting, if found, or the default value. - """ - ... - def pluginSettings(self, plugin_name: str) -> Dict[str, MoVariant]: - """ - Retrieve the settings in this mod for a plugin. - - Args: - plugin_name: Name of the plugin for which to retrieve settings. This should always be `IPlugin.name()` - unless you have a really good reason to access settings of another plugin. - - Returns: - A map from setting key to value. The map is empty if there are not settings for this mod. - """ - ... - def primaryCategory(self) -> int: - """ - Returns: - The ID of the primary category of this mod. - """ - ... - def remove(self) -> bool: - """ - Delete the mod from the disc. - - This does not update the global ModInfo structure or indices. - - Returns: - True if the mod was deleted, False otherwise. - """ - ... - def removeCategory(self, name: str) -> bool: - """ - Unassign a category from this mod. - - Args: - name: Name of the category to remove. - - Returns: - True if the category was removed, False otherwise (e.g. if no such category - was assigned). - """ - ... - def repository(self) -> str: - """ - Returns: - The name of the repository from which this mod was installed. - """ - ... - def setGameName(self, name: str): - """ - Set the source game of this mod. - - Args: - name: The new source game short name of this mod. - """ - ... - def setIsEndorsed(self, endorsed: bool): - """ - Set endorsement state of the mod. - - Args: - endorsed: New endorsement state of this mod. - """ - ... - def setName(self, name: str) -> bool: - """ - Set the name of this mod. - - This will also update the name of the directory that contains this mod - - Args: - name: New name for this mod. - - Returns: - True if the name was changed, False if an error occured (e.g. if the name is not a valid - directory name). - """ - ... - def setNewestVersion(self, version: "VersionInfo"): - """ - Set the latest known version of this mod. - - Args: - version: The latest known version of this mod. - """ - ... - def setNexusID(self, nexus_id: int): - """ - Set the Nexus ID of this mod. - - Args: - nexus_id: Thew new Nexus ID of this mod. - """ - ... - def setPluginSetting(self, plugin_name: str, key: str, value: MoVariant) -> bool: - """ - Set the specified setting in this mod for a plugin. - - Args: - plugin_name: Name of the plugin for which to retrieve a setting. This should always be `IPlugin.name()` - unless you have a really good reason to access settings of another plugin. - key: Identifier of the setting. - value: New value for the setting to set. - - Returns: - True if the setting was set correctly, False otherwise. - """ - ... - def setVersion(self, version: "VersionInfo"): - """ - Set the version of this mod. - - Args: - version: The new version of this mod. - """ - ... - def trackedState(self) -> "TrackedState": - """ - Returns: - The tracked state of this mod. - """ - ... - def url(self) -> str: - """ - Returns: - The URL of this mod, or an empty QString() if no URL is associated - with this mod. - """ - ... - def validated(self) -> bool: - """ - Check if the mod was marked as validated by the user. - - MO2 uses ModDataChecker to check the content of mods, but sometimes these fail, in - which case mods are incorrectly marked as 'not containing valid games data'. Users can - choose to mark these mods as valid to hide the warning / flag. - - Returns: - True if th is mod was marked as containing valid game data. - """ - ... - def version(self) -> "VersionInfo": - """ - Returns: - The current version of this mod. - """ - ... - -class IModList: - """ - Interface to the mod-list. - - All api functions in this interface work need the internal name of a mod to find a - mod. For regular mods (mods the user installed) the display name (as shown to the user) - and internal name are identical. For other mods (non-MO mods) there is currently no way - to translate from display name to internal name because the display name might not me un-ambiguous. - """ - - def allMods(self) -> List[str]: - """ - Returns: - A list containing the internal names of all installed mods. - """ - ... - def displayName(self, name: str) -> str: - """ - Retrieve the display name of a mod from its internal name. - - If you received an internal name from the API (e.g. `IPluginList.origin`) then you should use - that name to identify the mod in all other api calls but use this function to retrieve the name - to show to the user. - - Args: - name: Internal name of the mod. - - Returns: - The display name of the given mod. - """ - ... - def onModMoved(self, callback: Callable[[str, int, int], None]) -> bool: - """ - Install a handler to be called when a mod is moved. - - Args: - callback: The function to call when a mod is moved. The first argument is the internal name of the - mod, the second argument the old priority and the third argument the new priority. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onModStateChanged(self, callback: Callable[[Dict[str, int]], None]) -> bool: - """ - Install a handler to be called when mod states change (enabled/disabled, endorsed, ...). - - Args: - callback: The function to call when the states of mod change. The argument is a map containing the - mods whose states have changed. Keys are internal mod names and values are mod states. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def priority(self, name: str) -> int: - """ - Retrieve the priority of a mod. - - Args: - name: Internal name of the mod. - - Returns: - The priority of the given mod. - """ - ... - @overload - def setActive(self, names: List[str], active: bool) -> int: - """ - Enable or disable a list of mods. - - Calling this will cause MO to re-evaluate its virtual file system so this is - a fairly expensive call. - - Args: - names: Internal names of the mod to enable or disable. - active: True to enable the mods, False to disable them. - - Returns: - True on success, False otherwise. - """ - ... - @overload - def setActive(self, name: str, active: bool) -> bool: - """ - Enable or disable a mod. - - Calling this will cause MO to re-evaluate its virtual file system so this is - a fairly expensive call. - - Args: - name: Internal name of the mod to enable or disable. - active: True to enable the mod, False to disable it. - - Returns: - True on success, False otherwise. - """ - ... - def setPriority(self, name: str, priority: int) -> bool: - """ - Change the priority of a mod. - - `priority` is the new priority after the move. Keep in mind that the mod disappears from its - old location and all mods with higher priority than the moved mod decrease in priority by one. - - Args: - name: Internal name of the mod. - priority: The new priority of the mod. - - Returns: - True if the priority was changed, False otherwise (if the name or priority were invalid). - """ - ... - def state(self, name: str) -> int: - """ - Retrieve the state of a mod. - - Args: - name: Internal name of the mod. - - Returns: - The state of the given mod. - """ - ... - -class IModRepositoryBridge(PyQt5.QtCore.QObject): - descriptionAvailable: PyQt5.QtCore.pyqtSignal = ... - filesAvailable: PyQt5.QtCore.pyqtSignal = ... - fileInfoAvailable: PyQt5.QtCore.pyqtSignal = ... - downloadURLsAvailable: PyQt5.QtCore.pyqtSignal = ... - endorsementsAvailable: PyQt5.QtCore.pyqtSignal = ... - endorsementToggled: PyQt5.QtCore.pyqtSignal = ... - trackedModsAvailable: PyQt5.QtCore.pyqtSignal = ... - trackingToggled: PyQt5.QtCore.pyqtSignal = ... - requestFailed: PyQt5.QtCore.pyqtSignal = ... - def _object(self) -> PyQt5.QtCore.QObject: - """ - Returns: - The underlying `QObject` for the bridge. - """ - ... - def requestDescription(self, game_name: str, mod_id: int, user_data: MoVariant): - """ - Request description of a mod. - - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - user_data: User data to be returned with the result. - """ - ... - def requestDownloadURL( - self, game_name: str, mod_id: int, file_id: int, user_data: MoVariant - ): - """ - Request download URL for mod file.0 - - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - file_id: ID of the file for which a URL should be returned. - user_data: User data to be returned with the result. - """ - ... - def requestFileInfo( - self, game_name: str, mod_id: int, file_id: int, user_data: MoVariant - ): - """ - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - file_id: ID of the file for which information is requested. - user_data: User data to be returned with the result. - """ - ... - def requestFiles(self, game_name: str, mod_id: int, user_data: MoVariant): - """ - Request the list of files belonging to a mod. - - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - user_data: User data to be returned with the result. - """ - ... - def requestToggleEndorsement( - self, - game_name: str, - mod_id: int, - mod_version: str, - endorse: bool, - user_data: MoVariant, - ): - """ - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - mod_version: Version of the mod. - endorse: - user_data: User data to be returned with the result. - """ - ... - -class IOrganizer: - """ - Interface to class that provides information about the running session - of Mod Organizer to be used by plugins. - """ - - def appVersion(self) -> "VersionInfo": - """ - Returns: - The running version of Mod Organizer. - """ - ... - def basePath(self) -> str: - """ - Returns: - The absolute path to the base directory of Mod Organizer. - """ - ... - def createMod(self, name: "GuessedString") -> "IModInterface": - """ - Create a new mod with the specified name. - - If a mod with the same name already exists, the user will be queried. If the user chooses - to merge or replace, the call will succeed, otheriwse the call will fail. - - Args: - name: Name of the mod to create. - - Returns: - An interface to the newly created mod that can be used to modify it, or `None` if the mod - could not be created. - """ - ... - def createNexusBridge(self) -> "IModRepositoryBridge": - """ - Create a new Nexus interface. - - Returns: - The newly created Nexus interface. - """ - ... - def downloadManager(self) -> "IDownloadManager": - """ - Returns: - The interface to the download manager. - """ - ... - def downloadsPath(self) -> str: - """ - Returns: - The absolute path to the download directory. - """ - ... - def findFileInfos( - self, path: str, filter: Callable[["FileInfo"], bool] - ) -> List["FileInfo"]: - """ - Find files in the virtual directory matching the specified filter. - - Args: - path: The path to search in (relative to the 'data' folder). - filter: The function to use to filter files. Should return True for the files to keep. - - Returns: - The list of `QFileInfo` corresponding to the matching files. - """ - ... - @overload - def findFiles(self, path: str, filter: Callable[[str], bool]) -> List[str]: - """ - Find files in the given folder that matches the given filter. - - Args: - path: The path to search in (relative to the 'data' folder). - filter: The function to use to filter files. Should return True for the files to keep. - - Returns: - The list of matching files. - """ - ... - @overload - def findFiles(self, path: str, patterns: List[str]) -> List[str]: - """ - Find files in the given folder that matches one of the given glob patterns. - - Args: - path: The path to search in (relative to the 'data' folder). - patterns: List of glob patterns to match against. - - Returns: - The list of matching files. - """ - ... - @overload - def findFiles(self, path: str, pattern: str) -> List[str]: - """ - Find files in the given folder that matches the given glob pattern. - - Args: - path: The path to search in (relative to the 'data' folder). - pattern: The glob pattern to use to filter files. - - Returns: - The list of matching files. - """ - ... - def getFileOrigins(self, filename: str) -> List[str]: - """ - Retrieve the file origins for the speicified file. - - The origins are listed with their internal name. The internal name of a mod can differ - from the display name for disambiguation. - - Args: - filename: Path to the file to retrieve origins for (relative to the 'data' folder). - - Returns: - The list of origins that contain the specified file, sorted by their priority. - """ - ... - def getGame(self, name: str) -> "IPluginGame": - """ - Retrieve the game plugin matching the given name. - - Args: - name: Name of the game (short name). - - Returns: - The plugin for the given game, or `None` if none was found. - """ - ... - def getMod(self, name: str) -> "IModInterface": - """ - Retrieve an interface to a mod using its name. - - Args: - name: Name of the mod to retrieve. - - Returns: - An interface to the given mod, or `None` if there is no mod with this name - """ - ... - def installMod(self, filename: str, name_suggestion: str = "") -> "IModInterface": - """ - Install a mod archive at the specified location. - - Args: - filename: Absolute filepath to the archive to install. - name_suggestion: Suggested name for this mod. This can still be changed by the user. - - Returns: - An interface to the new installed mod, or `None` if no installation took place (canceled or failure). - """ - ... - def listDirectories(self, directory: str) -> List[str]: - """ - Retrieve the list of (virtual) subdirectories in the given path. - - Args: - directory: Path to the directory to list (relative to the 'data' folder). - - Returns: - The list of directories in the given directory. - """ - ... - def managedGame(self) -> "IPluginGame": - """ - Returns: - The plugin corresponding to the current game. - """ - ... - def modDataChanged(self, mod: "IModInterface"): - """ - Notify the organizer that the given mod has changed. - - Args: - mod: The mod that has changed. - """ - ... - def modList(self) -> "IModList": - """ - Returns: - The interface to the mod list. - """ - ... - def modsPath(self) -> str: - """ - Returns: - The (absolute) path to the mods directory. - """ - ... - def modsSortedByProfilePriority(self) -> List[str]: - """ - Returns: - The list of mod (names), sorted according to the current profile priorities. - """ - ... - def onAboutToRun(self, callback: Callable[[str], bool]) -> bool: - """ - Install a new handler to be called when an application is about to run. - - Multiple handlers can be installed. If any of the handler returns `False`, the application will - not run. - - Args: - callback: The function to call when an application is about to run. The parameter is the absolute path - to the application to run. The function can return False to prevent the application from running. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onFinishedRun(self, callback: Callable[[str, int], None]) -> bool: - """ - Install a new handler to be called when an application has finished running. - - Args: - callback: The function to call when an application has finished running. The first parameter is the absolute - path to the application, and the second parameter is the exit code of the application. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onModInstalled(self, callback: Callable[[str], None]) -> bool: - """ - Install a new handler to be called when a new mod is installed. - - Args: - callback: The function to call when a mod is installed. The parameter of the function is the name of the - installed mod. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onPluginSettingChanged( - self, callback: Callable[[str, str, MoVariant, MoVariant], None] - ) -> bool: - """ - Install a new handler to be called when a plugin setting is changed. - - Args: - callback: The function to call when a plugin setting is changed. The parameters are: The name of the plugin, the - name of the setting, the old value (or `None` if the setting did not exist before) and the new value - of the setting (or `None` if the setting has been removed). - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onProfileChanged( - self, callback: Callable[["IProfile", "IProfile"], None] - ) -> bool: - """ - Install a new handler to be called when the current profile is changed. - - The function is called when the profile is changed but some operations related to - the profile might not be finished when this is called (e.g., the virtual file system - might not be up-to-date). - - Args: - callback: The function to call when the current profile is changed. The first parameter is the old profile (can - be `None`, e.g. at startup), and the second parameter is the new profile (cannot be `None`). - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onUserInterfaceInitialized( - self, callback: Callable[[PyQt5.QtWidgets.QMainWindow], None] - ) -> bool: - """ - Install a new handler to be called when the UI has been fully initialized. - - Args: - callback: The function to call when the user-interface has been fully initialized. The parameter is the main - window of the application (`QMainWindow`). - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def overwritePath(self) -> str: - """ - Returns: - The (absolute) path to the overwrite directory. - """ - ... - def persistent( - self, plugin_name: str, key: str, default: MoVariant = None - ) -> MoVariant: - """ - Retrieve the specified persistent value for a plugin. - - A persistent is an arbitrary value that the plugin can set and retrieve that is persistently stored - by the main application. There is no UI for the user to change this value but they can directly access - the storage - - Args: - plugin_name: Name of the plugin for which to retrieve the value. This should always be IPlugin::name() unless you have a - really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - default: Default value to return if the key is not set (yet). - - Returns: - The value corresponding to the given persistent setting, or `def` is the key is not found. - """ - ... - def pluginDataPath(self) -> str: - """ - Retrieve the path to a directory where plugin data should be stored. - - For python plugins, it is recommended to use a dedicated folder (per plugin) if you need to - store data (resources, or multiple python files). - - Returns: - Path to a directory where plugin data should be stored. - """ - ... - def pluginList(self) -> "IPluginList": - """ - Returns: - The plugin list interface. - """ - ... - def pluginSetting(self, plugin_name: str, key: str) -> MoVariant: - """ - Retrieve settings of plugins. - - Args: - plugin_name: Name of the plugin to retrieve the setting for. - key: Name of the setting to retrieve the value for. - - Returns: - The value of the setting. - """ - ... - def profile(self) -> "IProfile": - """ - Returns: - The interface to the current profile. - """ - ... - def profileName(self) -> str: - """ - Returns: - The name of the current profile, or an empty string if no profile has been loaded (yet). - """ - ... - def profilePath(self) -> str: - """ - Returns: - The absolute path to the active profile or an empty string if no profile has been loaded (yet). - """ - ... - def refreshModList(self, save_changes: bool = True): - """ - Refresh the mod list. - - Args: - save_changes: If True, the relevant profile information is saved first (enabled mods and order of mods). - """ - ... - def removeMod(self, mod: "IModInterface") -> bool: - """ - Remove a mod (from disc and from the UI). - - Args: - mod: The mod to remove. - - Returns: - True if the mod was removed, False otherwise. - """ - ... - def resolvePath(self, filename: str) -> str: - """ - Resolves a path relative to the virtual data directory to its absolute real path. - - Args: - filename: Path to resolve. - - Returns: - The absolute real path, or an empty string if the path was not found. - """ - ... - def setPersistent( - self, plugin_name: str, key: str, value: MoVariant, sync: bool = True - ): - """ - Set the specified persistent value for a plugin. - - This does not update the in-memory value for this setting, see `setPluginSetting()` for this. - - Args: - plugin_name: Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a - really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - value: New value for the setting. - sync: If True, the storage is immediately written to disc. This costs performance but is safer against data loss. - """ - ... - def setPluginSetting(self, plugin_name: str, key: str, value: MoVariant): - """ - Set the specified setting for a plugin. - - This automatically notify handlers register with `onPluginSettingChanged`, so you do not have to do it yourself. - - Args: - plugin_name: Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a - really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - value: New value for the setting. - """ - ... - def startApplication( - self, - executable: str, - args: List[str] = [], - cwd: str = "", - profile: str = "", - forcedCustomOverwrite: str = "", - ignoreCustomOverwrite: bool = False, - ) -> int: - """ - Starts an application with virtual filesystem active. - - Args: - executable: Name or path of the executable. If this is only a filename, it will only work if it has been configured - in MO as an executable. If it is a relative path it is expected to be relative to the game directory. - args: Arguments to pass to the executable. If the list is empty, and `executable` refers to a configured executable, - the configured arguments are used. - cwd: The working directory for the executable. If this is empty, the path to the executable is used unless `executable` - referred to a configured MO executable, in which case the configured cwd is used. - profile: Profile to use. If this is empty (the default) the current profile is used. - forcedCustomOverwrite: The mod to set as the custom overwrite, regardless of what the profile has configured. - ignoreCustomOverwrite: Set to true to ignore the profile's configured custom overwrite. - - Returns: - The handle to the started application, or 0 if the application failed to start. - """ - ... - def waitForApplication(self, handle: int) -> Tuple[bool, int]: - """ - Wait for the application corresponding to the given handle to finish. - - This will always show the lock overlay, regardless of whether the - user has disabled locking in the setting, so use this with care. - Note that the lock overlay will always allow the user to unlock, in - which case this will return False. - - Args: - handle: Handle of the application to wait for (as returned by `startApplication()`). - - Returns: - A tuple `(result, exitcode)`, where `result` is a boolean indicating if the application - completed successfully, and `exitcode` is the exit code of the application. - """ - ... - -class IPlugin(abc.ABC): - """ - Base class for all plugins. - """ - - def __init__(self): ... - @abc.abstractmethod - def author(self) -> str: - """ - Returns: - The name of the plugin author. - """ - ... - @abc.abstractmethod - def description(self) -> str: - """ - Returns: - The description for this plugin. - """ - ... - @abc.abstractmethod - def init(self, organizer: "IOrganizer") -> bool: - """ - Initialize this plugin. - - Args: - organizer: The main organizer interface. - - Returns: - True if the plugin was initialized correctly, False otherwise. - """ - ... - @abc.abstractmethod - def isActive(self) -> bool: - """ - Check if this plugin is active. - - It is possible to use a plugin setting (specified in `settings()`) here to allow - users to manually enable/disable a plugin. - - Returns: - True if this plugin is active, False otherwise. - """ - ... - def localizedName(self) -> str: - """ - Retrieve the localized name of the plugin. - - Unlike `name()`, this method can (and should!) return a localized name for the plugin. - This method returns name() by default. - - Returns: - The localized name of the plugin. - """ - ... - def master(self) -> "IPlugin": - """ - Retrieve the master plugin of this plugin. - - It is often easier to implement a functionality as multiple plugins in MO2, but ship the - plugins together, e.g. as a Python module or using `createFunctions()`. In this case, having - a master plugin (one of the plugin, or a separate one) tells MO2 that these plugins are - linked and should also be displayed together in the UI. If MO2 ever implements automatic - updates for plugins, the `master()` plugin will also be used for this purpose. - - Returns: - The master plugin of this plugin, or a null pointer if this plugin does not have a master. - """ - ... - @abc.abstractmethod - def name(self) -> str: - """ - Retrieve the name of the plugin. - - The name of the plugin is used for internal storage purpose so it should not change, - and it should be static. In particular, you should not use a localized string (`tr()`) - for the plugin name. - - In the future, we will provide a way to localized plugin names using a distinct method, - such as `localizedName()`. - - Returns: - The name of the plugin. - """ - ... - @abc.abstractmethod - def settings(self) -> List["PluginSetting"]: - """ - Returns: - A list of settings for this plugin. - """ - ... - @abc.abstractmethod - def version(self) -> "VersionInfo": - """ - Returns: - The version of this plugin. - """ - ... - -class IPluginDiagnose(IPlugin): - """ - Plugins that create problem reports to be displayed in the UI. - - This can be used to report problems related to the same plugin (which implements further - interfaces) or as a stand-alone diagnosis tool. - """ - - def __init__(self): ... - def _invalidate(self): - """ - Invalidate the problems corresponding to this plugin. - """ - ... - @abc.abstractmethod - def activeProblems(self) -> List[int]: - """ - Retrieve the list of active problems found by this plugin. - - This method returns a list of problem IDs, that are then used when calling other methods - such as `shortDescription()` or `hasGuidedFix()`. - - Returns: - The list of active problems for this plugin. - """ - ... - @abc.abstractmethod - def fullDescription(self, key: int) -> str: - """ - Retrieve the full description of the problem corresponding to the given key. - - Args: - key: ID of the problem. - - Returns: - The full description of the problem. - - Raises: - IndexError: If the key is not valid. - """ - ... - @abc.abstractmethod - def hasGuidedFix(self, key: int) -> bool: - """ - Check if the problem corresponding to the given key has a guided fix. - - Args: - key: ID of the problem. - - Returns: - True if there is a guided fix for the problem, False otherwise. - - Raises: - IndexError: If the key is not valid. - """ - ... - @abc.abstractmethod - def shortDescription(self, key: int) -> str: - """ - Retrieve the short description of the problem corresponding to the given key. - - Args: - key: ID of the problem. - - Returns: - The short description of the problem. - - Raises: - IndexError: If the key is not valid. - """ - ... - @abc.abstractmethod - def startGuidedFix(self, key: int): - """ - Starts a guided fix for the problem corresponding to the given key. - - This method should throw `ValueError` if there is no guided fix for the corresponding - problem. - - Args: - key: ID of the problem. - - Raises: - IndexError: If the key is not valid. - ValueError: If there is no guided fix for this problem. - """ - ... - -class IPluginFileMapper(IPlugin): - """ - Plugins that adds virtual file links. - """ - - def __init__(self): ... - @abc.abstractmethod - def mappings(self) -> List["Mapping"]: - """ - Returns: - Mapping for the virtual file system (VFS). - """ - ... - -class IPluginGame(IPlugin): - """ - Base classes for game plugins. - - Each game requires a specific game plugin. These plugins were initially designed for - Bethesda games, so a lot of methods and attributes are irrelevant for other games. If - you wish to write a plugin for a much simpler game, please consider the `basic_games` - plugin: https://github.com/ModOrganizer2/modorganizer-basic_games - """ - - def __init__(self): ... - @abc.abstractmethod - def CCPlugins(self) -> List[str]: - """ - Returns: - The current list of active Creation Club plugins. - """ - ... - @abc.abstractmethod - def DLCPlugins(self) -> List[str]: - """ - Returns: - The list of esp/esm files that are part of known DLCs. - """ - ... - @abc.abstractmethod - def binaryName(self) -> str: - """ - Returns: - The name of the default executable to run (relative to the game folder). - """ - ... - @abc.abstractmethod - def dataDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The name of the directory containing data (relative to the game folder). - """ - ... - @abc.abstractmethod - def documentsDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The directory of the documents folder where configuration files and such for this game reside. - """ - ... - @abc.abstractmethod - def executableForcedLoads(self) -> List["ExecutableForcedLoadSetting"]: - """ - Returns: - A list of automatically discovered libraries that can be force loaded with executables. - """ - ... - @abc.abstractmethod - def executables(self) -> List["ExecutableInfo"]: - """ - Returns: - A list of automatically discovered executables of the game itself and tools surrounding it. - """ - ... - def feature(self, feature_type: Type[GameFeatureType]) -> GameFeatureType: - """ - Retrieve a specified game feature from this plugin. - - Args: - feature_type: The class of feature to retrieve. - - Returns: - The game feature corresponding to the given type, or `None` if the feature is - not implemented. - """ - ... - def featureList(self) -> Dict[Type[GameFeatureType], GameFeatureType]: - """ - Retrieve the list of game features implemented for this plugin. - - Python plugin should not implement this method but `_featureList()`. - - Returns: - A mapping from feature type to actual game features. - """ - ... - @abc.abstractmethod - def gameDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The directory containing the game installation. - """ - ... - @abc.abstractmethod - def gameIcon(self) -> PyQt5.QtGui.QIcon: - """ - Returns: - The icon representing the game. - """ - ... - @abc.abstractmethod - def gameName(self) -> str: - """ - Returns: - The name of the game (as displayed to the user). - """ - ... - @abc.abstractmethod - def gameNexusName(self) -> str: - """ - Returns: - The name of the game identifier for Nexus. - """ - ... - @abc.abstractmethod - def gameShortName(self) -> str: - """ - Returns: - The short name of the game. - """ - ... - @abc.abstractmethod - def gameVariants(self) -> List[str]: - """ - Retrieve the list of variants for this game. - - If there are multiple variants of a game (and the variants make a difference to the - plugin), like a regular one and a GOTY-edition, the plugin can return a list of them - and the user gets to chose which one he owns. - - Returns: - The list of variants of the game. - """ - ... - @abc.abstractmethod - def gameVersion(self) -> str: - """ - Returns: - The version of the game. - """ - ... - @abc.abstractmethod - def getLauncherName(self) -> str: - """ - Returns: - The name of the launcher executable to run (relative to the game folder), or an - empty string if there is no launcher. - """ - ... - @abc.abstractmethod - def iniFiles(self) -> List[str]: - """ - Returns: - The list of INI files this game uses. The first file in the list should be the - 'main' INI file. - """ - ... - @abc.abstractmethod - def initializeProfile(self, directory: PyQt5.QtCore.QDir, settings: int): - """ - Initialize a profile for this game. - - The MO app does not yet support virtualizing only specific aspects but plugins should be written - with this future functionality in mind. - - This function will be used to initially create a profile, potentially to repair it or upgrade/downgrade - it so the implementations have to gracefully handle the case that the directory already contains files. - - Args: - directory: The directory where the profile is to be initialized. - settings: The parameters for how the profile should be initialized. - """ - ... - @abc.abstractmethod - def isInstalled(self) -> bool: - """ - Returns: - True if this game has been discovered as installed, False otherwise. - """ - ... - @abc.abstractmethod - def loadOrderMechanism(self) -> "LoadOrderMechanism": - """ - Returns: - The load order mechanism used by this game. - """ - ... - @abc.abstractmethod - def looksValid(self, directory: PyQt5.QtCore.QDir) -> bool: - """ - Check if the given directory looks like a valid game installation. - - Args: - directory: Directory to check. - - Returns: - True if the directory looks like a valid installation of this game, False otherwise. - """ - ... - @abc.abstractmethod - def nexusGameID(self) -> int: - """ - Retrieve the Nexus game ID for this game. - - Example: For Skyrim, the Nexus game ID is 110. - - Returns: - The Nexus game ID for this game. - """ - ... - @abc.abstractmethod - def nexusModOrganizerID(self) -> int: - """ - Retrieve the Nexus mod ID of Mod Organizer for this game. - - Example: For Skyrim SE, the mod ID of MO2 is 6194. You can find the mod ID in the URL: - https://www.nexusmods.com/skyrimspecialedition/mods/6194 - - Returns: - The Nexus mod ID of Mod Organizer for this game. - """ - ... - @abc.abstractmethod - def primaryPlugins(self) -> List[str]: - """ - Returns: - The list of plugins that are part of the game and not considered optional. - """ - ... - @abc.abstractmethod - def primarySources(self) -> List[str]: - """ - Retrieve primary alternative 'short' names for this game. - - This is used to determine if a Nexus (or other) download source should be considered - as a primary source for the game so that it is not flagged as an alternative one. - - Returns: - The list of primary alternative 'short' names for this game, or an empty list. - """ - ... - @abc.abstractmethod - def savegameExtension(self) -> str: - """ - Returns: - The file extension of save games for this game. - """ - ... - @abc.abstractmethod - def savegameSEExtension(self) -> str: - """ - Returns: - The file extension of Script Extender saves for this game. - """ - ... - @abc.abstractmethod - def savesDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The directory where save games are stored. - """ - ... - @abc.abstractmethod - def setGamePath(self, path: str): - """ - Set the path to the managed game. - - This is called during instance creation if the game is not auto-detected and the user has - to specify the installation location. This is not called if the game has been auto-detected, - so `isInstalled()` should call this. - - Args: - path: Path to the game installation. - """ - ... - @abc.abstractmethod - def setGameVariant(self, variant: str): - """ - Set the game variant. - - If there are multiple variants of game (as returned by `gameVariants()`), this will be - called on start with the user-selected game variant. - - Args: - variant: The game variant selected by the user. - """ - ... - @abc.abstractmethod - def sortMechanism(self) -> "SortMechanism": - """ - Returns: - The sort mechanism for this game. - """ - ... - @abc.abstractmethod - def steamAPPId(self) -> str: - """ - Retrieve the Steam app ID for this game. - - If the game is not available on Steam, this should return an empty string. - - If a game is available in multiple versions, those might have different app ids. The plugin - should try to return the right one - - Returns: - The Steam app ID for this game. Should be empty for games not available on steam. - """ - ... - @abc.abstractmethod - def validShortNames(self) -> List[str]: - """ - Retrieve the valid 'short' names for this game. - - This is used to determine if a Nexus download is valid for the current game since not all - game variants have their own nexus pages and others can handle downloads from other nexus - game pages and should be allowed to do so (e.g., you can install some Skyrim LE mod even - when using Skyrim SE). - - The short name should be considered the primary handler for a directly supported game - for puroses of auto-launching an instance. - - Returns: - The list of valid short names for this game. - """ - ... - -class IPluginInstaller(IPlugin): - """ - This is the top-level class for installer. Actual installers should inherit either: - - - `IPluginInstallerSimple` if the installer can work directly with the archive. This is what - most installers use. - - `IPluginInstallerCustom` if the installer needs to perform custom operations. This is only - used by the external NCC installer and the OMOD installer. - """ - - @abc.abstractmethod - def isArchiveSupported(self, tree: "IFileTree") -> bool: - """ - Check if the given file tree corresponds to a supported archive for this installer. - - Args: - tree: The tree representing the content of the archive. - - Returns: - True if this installer can handle the archive, False otherwise. - """ - ... - @abc.abstractmethod - def isManualInstaller(self) -> bool: - """ - Check if this installer is a manual installer. - - Returns: - True if this installer is a manual installer, False otherwise. - """ - ... - @abc.abstractmethod - def onInstallationEnd(self, result: "InstallResult", new_mod: "IModInterface"): - """ - Method calls at the end of the installation process. This method is only called once - per installation process, even for recursive installations (e.g. with the bundle installer). - - Args: - result: The result of the installation. - new_mod: If the installation succeeded (result is RESULT_SUCCESS), contains the newly - installed mod, otherwise it contains a null pointer. - """ - ... - @abc.abstractmethod - def onInstallationStart( - self, archive: str, reinstallation: bool, current_mod: "IModInterface" - ): - """ - Method calls at the start of the installation process, before any other methods. - This method is only called once per installation process, even for recursive - installations (e.g. with the bundle installer). - - If `reinstallation` is true, then the given mod is the mod being reinstalled (the one - selected by the user). If `reinstallation` is false and `currentMod` is not null, then - it corresponds to a mod MO2 thinks corresponds to the archive (e.g. based on matching Nexus ID - or name). - - The default implementation does nothing. - - Args: - archive: Path to the archive that is going to be installed. - reinstallation: True if this is a reinstallation, False otherwise. - current_mod: A currently installed mod corresponding to the archive being installed, or None - if there is no such mod. - """ - ... - @abc.abstractmethod - def priority(self) -> int: - """ - Retrieve the priority of this installer. - - If multiple installers are able to handle an archive, the one with the highest priority wins. - - Returns: - The priority of this installer. - """ - ... - def setInstallationManager(self, manager: "IInstallationManager"): - """ - Set the installation manager for this installer. - - Python plugins usually do not need to re-implement this and can directly access the installation - manager using `_manager()`. - - Args: - manager: The installation manager. - """ - ... - def setParentWidget(self, parent: PyQt5.QtWidgets.QWidget): - """ - Set the parent widget for this installer. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - - Args: - parent: The parent widget. - """ - ... - -class IPluginInstallerCustom(IPluginInstaller): - """ - Custom installer for mods. Custom installers receive the archive name and have to go - from there. They have to be able to extract the archive themself. - - Example of such installers are the external NCC installer or the OMOD installer. - """ - - def __init__(self): ... - def _manager(self) -> "IInstallationManager": - """ - Returns: - The installation manager. - """ - ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def install( - self, - mod_name: "GuessedString", - game_name: str, - archive_name: str, - version: str, - nexus_id: int, - ) -> "InstallResult": - """ - Install the given archive. - - The mod needs to be created by calling `IOrganizer.createMod` first. - - Args: - mod_name: Name of the mod to install. As an input parameter this is the suggested name - (e.g. from meta data) The installer may change this parameter to rename the mod). - game_name: Name of the game for which the mod is installed. - archive_name: Name of the archive to install. - version: Version of the mod. May be empty if the version is not yet known. The plugin is responsible - for setting the version on the created mod. - nexus_id: ID of the mod or -1 if unknown. The plugin is responsible for setting the mod ID for the - created mod. - - Returns: - The result of the installation process. - """ - ... - @abc.abstractmethod - def isArchiveSupported(self, archive_name: str) -> bool: - """ - Check if the given file is a supported archive for this installer. - - Args: - archive_name: Name of the archive. - - Returns: - True if this installer can handle the archive, False otherwise. - """ - ... - @abc.abstractmethod - def supportedExtensions(self) -> List[str]: - """ - Returns: - A list of file extensions that this installer can handle. - """ - ... - -class IPluginInstallerSimple(IPluginInstaller): - """ - Simple installer for mods. Simple installers only deal with an in-memory structure - representing the archive and can modify what to install and where by editing this structure. - Actually extracting the archive is handled by the manager. - """ - - def __init__(self): ... - def _manager(self) -> "IInstallationManager": - """ - Returns: - The installation manager. - """ - ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def install( - self, name: "GuessedString", tree: "IFileTree", version: str, nexus_id: int - ) -> Union[ - "InstallResult", "IFileTree", Tuple["InstallResult", "IFileTree", str, int] - ]: - """ - Install a mod from an archive filetree. - - The installer can modify the given tree and use the manager to extract or create new - files. - - This method returns different type of objects depending on the actual result of the - installation. The C++ bindings for this method always returns a tuple (result, tree, - version, id). - - Args: - name: Name of the mod to install. As an input parameter this is the suggested name - (e.g. from meta data) The installer may change this parameter to rename the mod). - tree: In-memory representation of the archive content. - version: Version of the mod, or an empty string is unknown. - nexus_id: ID of the mod, or -1 if unknown. - - Returns: - In case of failure, the result of the installation, otherwise the modified tree or - a tuple (result, tree, version, id) containing the result of the installation, the - modified tree, the new version and the new ID. The tuple can be returned even if the - installation did not succeed. - """ - ... - -class IPluginList: - """ - Primary interface to the list of plugins. - """ - - def isMaster(self, name: str) -> bool: - """ - Check if a plugin is a master file (basically a library, referenced by other plugins). - - In gamebryo games, a master file will usually have a .esm file extension but technically - an esp can be flagged as master and an esm might not be. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - True if the given plugin is a master plugin, False otherwise or if the file does not exist. - """ - ... - def loadOrder(self, name: str) -> int: - """ - Retrieve the load order of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The load order of the plugin (the order in which the game loads it). If all plugins are enabled this - is the same as the priority but disabled plugins will have a load order of -1. This also returns -1 - if the plugin does not exist. - """ - ... - def masters(self, name: str) -> List[str]: - """ - Retrieve the list of masters required for a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The list of masters for the plugin (filenames with extension, no path). - """ - ... - def onPluginMoved(self, callback: Callable[[str, int, int], None]) -> bool: - """ - Install a new handler to be called when a plugin is moved. - - Args: - callback: The function to call when a plugin is moved. The first parameter is the plugin name, the - second the old priority of the plugin and the third one the new priority. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onPluginStateChanged(self, callback: Callable[[str, int], None]) -> bool: - """ - Install a new handler to be called when a plugin state changes. - - Args: - callback: The function to call when a plugin state changes. The first parameter is the plugin name, the - second the new state of the plugin. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onRefreshed(self, callback: Callable[[None], None]) -> bool: - """ - Install a new handler to be called when the list of plugins is refreshed. - - Args: - callback: The function to call when the list of plugins is refreshed. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def origin(self, name: str) -> str: - """ - Retrieve the origin of a plugin. This is either the (internal) name of a mod, `"overwrite"` or `"data"`. - - The internal name of a mod can differ from the display name for disambiguation. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The name of the origin of the plugin, or an empty string if the plugin does not exist. - """ - ... - def pluginNames(self) -> List[str]: - """ - Returns: - The list of all plugin names. - """ - ... - def priority(self, name: str) -> int: - """ - Retrieve the priority of a plugin. - - The higher the priority, the more important. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The priority of the given plugin, or -1 if the plugin does not exist. - """ - ... - def setLoadOrder(self, loadorder: List[str]): - """ - Set the load order. - - Plugins not included in the list will be placed at highest priority in the order they - were before. - - Args: - loadorder: The new load order, specified by the list of plugin names, sorted. - """ - ... - def setPriority(self, name: str, priority: int) -> bool: - """ - Change the priority of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - priority: New priority of the plugin. - - Returns: - True on success, False if the priority change was not possible. This is usually because - one of the parameters is invalid. The function returns true even if the plugin was not moved - at the specified priority (e.g. when trying to move a non-master plugin before a master one). - """ - ... - def setState(self, name: str, state: int): - """ - Set the state of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - state: New state of the plugin (`INACTIVE` or `ACTIVE`). - """ - ... - def state(self, name: str) -> int: - """ - Retrieve the state of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The state of the plugin. - """ - ... - -class IPluginModPage(IPlugin): - def __init__(self): ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def displayName(self) -> str: - """ - Returns: - The name of the page as displayed in the UI. - """ - ... - @abc.abstractmethod - def handlesDownload( - self, - page_url: PyQt5.QtCore.QUrl, - download_url: PyQt5.QtCore.QUrl, - fileinfo: "ModRepositoryFileInfo", - ) -> bool: - """ - Check if the plugin handles the specified download. - - Args: - page_url: URL of the page that contains the download link. - download_url: The download URL. - fileinfo: Not usable in python. - - Returns: - True if this plugin wants to handle the specified download, False otherwise. - """ - ... - @abc.abstractmethod - def icon(self) -> PyQt5.QtGui.QIcon: - """ - Returns: - The icon to display with the page. - """ - ... - @abc.abstractmethod - def pageURL(self) -> PyQt5.QtCore.QUrl: - """ - Returns: - The URL to open when the user wants to visit this mod page. - """ - ... - def setParentWidget(self, parent: PyQt5.QtWidgets.QWidget): - """ - Set the parent widget for this mod page. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - - Args: - parent: The parent widget. - """ - ... - @abc.abstractmethod - def useIntegratedBrowser(self) -> bool: - """ - Indicates if the page should be displayed in the integrated browser. - - Unless the page provides a special means of starting downloads (like the nxm:// url schema - on nexus), it will not be possible to handle downloads unless the integrated browser is used! - - Returns: - True if the page should be opened in the integrated browser, False otherwise. - """ - ... - -class IPluginPreview(IPlugin): - """ - These plugins add support for previewing files in the data pane. Right now all image formats supported - by qt are implemented (including dds) but no audio files and no 3d mesh formats. - """ - - def __init__(self): ... - @abc.abstractmethod - def genFilePreview( - self, filename: str, max_size: PyQt5.QtCore.QSize - ) -> PyQt5.QtWidgets.QWidget: - """ - Generate a preview for the specified file. - - Args: - filename: Path to the file to preview. - max_size: Maximum size of the generated widget. - - Returns: - The widget showing a preview of the file. - """ - ... - @abc.abstractmethod - def supportedExtensions(self) -> List[str]: - """ - Returns: - The list of file extensions that are supported by this preview plugin. - """ - ... - -class IPluginTool(IPlugin): - """ - This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools submenu - and get invoked when the user clicks it. They are expected to have a user interface of some sort. These - are almost like independent applications except they can access all Mod Organizer interfaces like querying - and modifying the current profile, mod list, load order, use MO to install mods and so on. A tool plugin - can (and should!) integrate its UI as a window inside MO and thus doesn't have to initialize a windows - application itself. - """ - - def __init__(self): ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def display(self): - """ - Called when the user starts the tool. - """ - ... - @abc.abstractmethod - def displayName(self) -> str: - """ - Returns: - The display name for this tool, as shown in the tool menu. - """ - ... - @abc.abstractmethod - def icon(self) -> PyQt5.QtGui.QIcon: - """ - Returns: - The icon for this tool, or a default-constructed QICon(). - """ - ... - def setParentWidget(self, parent: PyQt5.QtWidgets.QWidget): - """ - Set the parent widget for this tool. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - - Args: - parent: The parent widget. - """ - ... - @abc.abstractmethod - def tooltip(self) -> str: - """ - Returns: - The tooltip for this tool. - """ - ... - -class IProfile: - def absolutePath(self) -> str: ... - def invalidationActive(self) -> Tuple[bool, bool]: ... - def localSavesEnabled(self) -> bool: ... - def localSettingsEnabled(self) -> bool: ... - def name(self) -> str: ... - -class ISaveGame: - """ - Base class for information about what is in a save game. - """ - - def __init__(self): ... - def allFiles(self) -> List[str]: - """ - Returns: - The list of all files related to this save. - """ - ... - def getCreationTime(self) -> PyQt5.QtCore.QDateTime: - """ - Retrieve the creation time of the save. - - The creation time of a save is not always the same as the creation time of - the file containing the save. - - Returns: - The creation time of the save. - """ - ... - def getFilename(self) -> str: - """ - Returns: - The name of the (main) save file. - """ - ... - def getSaveGroupIdentifier(self) -> str: - """ - Retrieve the name of the group this files belong to. - - The name can be used to identify sets of saves to transfer between profiles. For - RPG games, this is usually the name of a character. - - Returns: - The group identifier for this save game. - """ - ... - def hasScriptExtenderFile(self) -> bool: - """ - Returns: - True if this save game has an associated script extender save, False otherwise. - """ - ... - -class ISaveGameInfoWidget(PyQt5.QtWidgets.QWidget): - """ - Base class for a save game info widget. - """ - - def __init__(self, parent: PyQt5.QtWidgets.QWidget = None): - """ - Args: - parent: Parent widget. - """ - ... - def _widget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The underlying `QWidget`. - """ - ... - @abc.abstractmethod - def setSave(self, save: str): - """ - Set the save file to display in this widget. - - Args: - save: Path to the save file. - """ - ... - -class LocalSavegames(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def mappings(self, profile_save_dir: PyQt5.QtCore.QDir) -> List["Mapping"]: ... - @abc.abstractmethod - def prepareProfile(self, profile: "IProfile") -> bool: ... - -class Mapping: - @property - def createTarget(self) -> bool: ... - @createTarget.setter - def createTarget(self, arg0: bool): ... - @property - def destination(self) -> str: ... - @destination.setter - def destination(self, arg0: str): ... - @property - def isDirectory(self) -> bool: ... - @isDirectory.setter - def isDirectory(self, arg0: bool): ... - @property - def source(self) -> str: ... - @source.setter - def source(self, arg0: str): ... - def __init__(self): - """ - Creates an empty Mapping. - """ - ... - -class ModDataChecker(abc.ABC): - """ - Game feature that is used to check the content of a data tree. - """ - - class CheckReturn(Enum): - INVALID = ... - FIXABLE = ... - VALID = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - FIXABLE: "ModDataChecker.CheckReturn" = ... - INVALID: "ModDataChecker.CheckReturn" = ... - VALID: "ModDataChecker.CheckReturn" = ... - def __init__(self): ... - @abc.abstractmethod - def dataLooksValid(self, filetree: "IFileTree") -> "ModDataChecker.CheckReturn": - """ - Check that the given filetree represent a valid mod layout, or can be easily - fixed. - - This method is mainly used during installation (to find which installer should - be used or to recurse into multi-level archives), or to quickly indicates to a - user if a mod looks valid. - - This method does not have to be exact, it only has to indicate if the given tree - looks like a valid mod or not by quickly checking the structure (heavy operations - should be avoided). - - If the tree can be fixed by the `fix()` method, this method should return `FIXABLE`. - `FIXABLE` should only be returned when it is guaranteed that `fix()` can fix the tree. - - Args: - filetree: The tree starting at the root of the "data" folder. - - Returns: - Whether the tree is invalid, fixable or valid. - """ - ... - def fix(self, filetree: "IFileTree") -> Optional["IFileTree"]: - """ - Try to fix the given tree. - - This method is used during installation to try to fix invalid archives and will only be - called if dataLooksValid returned `FIXABLE`. - - Args: - filetree: The tree to try to fix. Can be modified during the process. - - Returns: - The fixed tree, or a null pointer if the tree could not be fixed. - """ - ... - -class ModDataContent(abc.ABC): - """ - The ModDataContent feature is used (when available) to indicate to users the content - of mods in the "Content" column. - - The feature exposes a list of possible content types, each associated with an ID, a name - and an icon. The icon is the path to either: - - - A Qt resource or; - - A file on the disk. - - In order to facilitate the implementation, MO2 already provides a set of icons that can - be used. Those icons are all under ``:/MO/gui/content`` (e.g. ``:/MO/gui/content/plugin`` or ``:/MO/gui/content/music`` `). - - The list of available icons is: - - - ``plugin``: |plugin-icon| - - ``skyproc``: |skyproc-icon| - - ``texture``: |texture-icon| - - ``music``: |music-icon| - - ``sound``: |sound-icon| - - ``interface``: |interface-icon| - - ``skse``: |skse-icon| - - ``script``: |script-icon| - - ``mesh``: |mesh-icon| - - ``string``: |string-icon| - - ``bsa``: |bsa-icon| - - ``menu``: |menu-icon| - - ``inifile``: |inifile-icon| - - ``modgroup``: |modgroup-icon| - - .. |plugin-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/jigsaw-piece.png - .. |skyproc-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/hand-of-god.png - .. |texture-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/empty-chessboard.png - .. |music-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/double-quaver.png - .. |sound-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/lyre.png - .. |interface-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/usable.png - .. |skse-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/checkbox-tree.png - .. |script-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/tinker.png - .. |mesh-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/breastplate.png - .. |string-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/conversation.png - .. |bsa-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/locked-chest.png - .. |menu-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/config.png - .. |inifile-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/feather-and-scroll.png - .. |modgroup-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/xedit.png - """ - - class Content: - @property - def icon(self) -> str: ... - @property - def id(self) -> int: ... - @property - def name(self) -> str: ... - def __init__(self, id: int, name: str, icon: str, filter_only: bool = False): - """ - Args: - id: ID of this content. - name: Name of this content. - icon: Path to the icon for this content. Can be either a path - to an image on the disk, or to a resource. Can be an empty string if filterOnly - is true. - filter_only: Indicates if the content should only be show in the filter - criteria and not in the actual Content column. - """ - ... - def isOnlyForFilter(self) -> bool: - """ - Returns: - True if this content is only meant to be used as a filter criteria. - """ - ... - def __init__(self): ... - @abc.abstractmethod - def getAllContents(self) -> List["ModDataContent.Content"]: - """ - Returns: - The list of all possible contents for the corresponding game. - """ - ... - @abc.abstractmethod - def getContentsFor(self, filetree: "IFileTree") -> List[int]: - """ - Retrieve the list of contents in the given tree. - - Args: - filetree: The tree corresponding to the mod to retrieve contents for. - - Returns: - The IDs of the content in the given tree. - """ - ... - -class ModRepositoryFileInfo: - @property - def categoryID(self) -> int: ... - @categoryID.setter - def categoryID(self, arg0: int): ... - @property - def description(self) -> str: ... - @description.setter - def description(self, arg0: str): ... - @property - def fileCategory(self) -> int: ... - @fileCategory.setter - def fileCategory(self, arg0: int): ... - @property - def fileID(self) -> int: ... - @fileID.setter - def fileID(self, arg0: int): ... - @property - def fileName(self) -> str: ... - @fileName.setter - def fileName(self, arg0: str): ... - @property - def fileSize(self) -> int: ... - @fileSize.setter - def fileSize(self, arg0: int): ... - @property - def fileTime(self) -> PyQt5.QtCore.QDateTime: ... - @fileTime.setter - def fileTime(self, arg0: PyQt5.QtCore.QDateTime): ... - @property - def gameName(self) -> str: ... - @gameName.setter - def gameName(self, arg0: str): ... - @property - def modID(self) -> int: ... - @modID.setter - def modID(self, arg0: int): ... - @property - def modName(self) -> str: ... - @modName.setter - def modName(self, arg0: str): ... - @property - def name(self) -> str: ... - @name.setter - def name(self, arg0: str): ... - @property - def newestVersion(self) -> "VersionInfo": ... - @newestVersion.setter - def newestVersion(self, arg0: "VersionInfo"): ... - @property - def repository(self) -> str: ... - @repository.setter - def repository(self, arg0: str): ... - @property - def uri(self) -> str: ... - @uri.setter - def uri(self, arg0: str): ... - @property - def userData(self) -> MoVariant: ... - @userData.setter - def userData(self, arg0: MoVariant): ... - @property - def version(self) -> "VersionInfo": ... - @version.setter - def version(self, arg0: "VersionInfo"): ... - @overload - def __init__(self, other: "ModRepositoryFileInfo"): ... - @overload - def __init__( - self, game_name: str = None, mod_id: int = None, file_id: int = None - ): ... - def __str__(self) -> str: ... - @staticmethod - def createFromJson(data: str) -> "ModRepositoryFileInfo": ... - -class PluginSetting: - """ - Class to hold the user-configurable parameters a plugin accepts. The purpose of this class is - only to inform the application what settings to offer to the user, it does not hold the actual value. - """ - - @property - def default_value(self) -> MoVariant: ... - @default_value.setter - def default_value(self, arg0: MoVariant): ... - @property - def description(self) -> str: ... - @description.setter - def description(self, arg0: str): ... - @property - def key(self) -> str: ... - @key.setter - def key(self, arg0: str): ... - def __init__(self, key: str, description: str, default_value: MoVariant): - """ - Args: - key: Name of the setting. - description: Description of the setting. - default_value: Default value of the setting. - """ - ... - -class SaveGameInfo(abc.ABC): - """ - Feature to get hold of stuff to do with save games. - """ - - def __init__(self): ... - @abc.abstractmethod - def getMissingAssets(self, filepath: str) -> Dict[str, List[str]]: - """ - Retrieve missing assets from the save. - - Args: - filepath: Path to the save file. - - Returns: - A collection of missing assets and the modules that can supply those assets. - """ - ... - @abc.abstractmethod - def getSaveGameInfo(self, filepath: str) -> "ISaveGame": - """ - Retrieve the information about the supplied save game. - - Args: - filepath: Path to the save file. - - Returns: - A SaveGame corresponding to the given save file. - """ - ... - @abc.abstractmethod - def getSaveGameWidget( - self, parent: PyQt5.QtWidgets.QWidget - ) -> Optional["ISaveGameInfoWidget"]: - """ - Retrieve a widget to display over the save game list. - - This method is allowed to return `None` in case no widget has been implemented. - - Args: - parent: The parent widget. - - Returns: - A SaveGameInfoWidget to display information about save game. - """ - ... - @abc.abstractmethod - def hasScriptExtenderSave(self, filepath: str) -> bool: - """ - Check whether or not the save has a paired script extender save. - - Args: - filepath: Path to the save file. - - Returns: - True if the given save file has a paired script extender save, False otherwise. - """ - ... - -class ScriptExtender(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def BinaryName(self) -> str: - """ - Returns: - The name of the script extender binary. - """ - ... - @abc.abstractmethod - def PluginPath(self) -> str: - """ - Returns: - The script extender plugin path, relative to the data folder. - """ - ... - @abc.abstractmethod - def getArch(self) -> int: - """ - Returns: - The CPU platform of the extender. - """ - ... - @abc.abstractmethod - def getExtenderVersion(self) -> str: - """ - Returns: - The version of the script extender. - """ - ... - @abc.abstractmethod - def isInstalled(self) -> bool: - """ - Returns: - True if the script extender is installed, False otherwise. - """ - ... - @abc.abstractmethod - def loaderName(self) -> str: - """ - Returns: - The loader to use to ensure the game runs with the script extender. - """ - ... - @abc.abstractmethod - def loaderPath(self) -> str: - """ - Returns: - The fullpath to the script extender loader. - """ - ... - @abc.abstractmethod - def saveGameAttachmentExtensions(self) -> List[str]: - """ - Returns: - Additional savegame attachments. - """ - ... - -class UnmanagedMods(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def displayName(self, mod_name: str) -> str: - """ - Retrieve the display name of a given mod. - - Args: - mod_name: Internal name of the mod. - - Returns: - The display name of the mod. - """ - ... - @abc.abstractmethod - def mods(self, official_only: bool) -> List[str]: - """ - Retrieve the list of unmanaged mods for the corresponding game. - - Args: - official_only: Retrieve only unmanaged official mods. - - Returns: - The list of unmanaged mods (internal names). - """ - ... - @abc.abstractmethod - def referenceFile(self, mod_name: str) -> PyQt5.QtCore.QFileInfo: - """ - Retrieve the reference file for the requested mod. - - Example: For Bethesda games, the reference file may be the main - plugin (esp or esm) for the game or a DLCs. - - Args: - mod_name: Internal name of the mod. - - Returns: - The reference file (absolute path) for the requested mod. - """ - ... - @abc.abstractmethod - def secondaryFiles(self, mod_name: str) -> List[str]: - """ - Retrieve the secondary files for the requested mod. - - Example: For Bethesda games, the secondary files may be the archives - corresponding to the reference file. - - Args: - mod_name: Internal name of the mod. - - Returns: - The secondary files (absolute paths) for the request mod. - """ - ... - -class VersionInfo: - """ - Represents the version of a mod or plugin. - """ - - @overload - def __init__(self): - """ - Construct an invalid VersionInfo. - """ - ... - @overload - def __init__(self, value: str, scheme: "VersionScheme" = VersionScheme.DISCOVER): - """ - Construct a VersionInfo by parsing the given string according to the given scheme. - - Args: - value: String to parse. - scheme: Scheme to use to parse the string. - """ - ... - @overload - def __init__( - self, - major: int, - minor: int, - subminor: int, - subsubminor: int, - release_type: "ReleaseType" = ReleaseType.FINAL, - ): - """ - Construct a VersionInfo using the given elements. - - Args: - major: Major version. - minor: Minor version. - subminor: Subminor version. - subsubminor: Subsubminor version. - release_type: Type of release. - """ - ... - @overload - def __init__( - self, - major: int, - minor: int, - subminor: int, - release_type: "ReleaseType" = ReleaseType.FINAL, - ): - """ - Construct a VersionInfo using the given elements. - - Args: - major: Major version. - minor: Minor version. - subminor: Subminor version. - release_type: Type of release. - """ - ... - @overload - def __eq__(self, arg2: "VersionInfo") -> bool: ... - @overload - def __eq__(self, other: object) -> bool: ... - def __ge__(self, arg2: "VersionInfo") -> bool: ... - def __gt__(self, arg2: "VersionInfo") -> bool: ... - def __le__(self, arg2: "VersionInfo") -> bool: ... - def __lt__(self, arg2: "VersionInfo") -> bool: ... - @overload - def __ne__(self, arg2: "VersionInfo") -> bool: ... - @overload - def __ne__(self, other: object) -> bool: ... - def __str__(self) -> str: - """ - Returns: - See `canonicalString()`. - """ - ... - def canonicalString(self) -> str: - """ - Returns: - A canonical string representing this version, that can be stored and then parsed using the parse() method. - """ - ... - def clear(self): - """ - Resets this VersionInfo to an invalid version. - """ - ... - def displayString(self, forced_segments: int = 2) -> str: - """ - Args: - forced_segments: The number of version segments to display even if the version is 0. 1 is major, 2 is major - and minor, etc. The only implemented ranges are (-inf,2] for major/minor, [3] for major/minor/subminor, - and [4,inf) for major/minor/subminor/subsubminor. This only versions with a regular scheme. - - Returns: - A string for display to the user. The returned string may not contain enough information to reconstruct this version info. - """ - ... - def isValid(self) -> bool: - """ - Returns: - True if this VersionInfo is valid, False otherwise. - """ - ... - def parse( - self, - value: str, - scheme: "VersionScheme" = VersionScheme.DISCOVER, - manual_input: bool = False, - ): - """ - Update this VersionInfo by parsing the given string using the given scheme. - - Args: - value: String to parse. - scheme: Scheme to use to parse the string. - manual_input: True if the given string should be treated as user input. - """ - ... - def scheme(self) -> "VersionScheme": - """ - Returns: - The version scheme in effect for this VersionInfo. - """ - ... diff --git a/stubs/setup/.gitignore b/stubs/setup/.gitignore deleted file mode 100644 index 057bfac..0000000 --- a/stubs/setup/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -build -dist -mobase_stubs.egg-info \ No newline at end of file diff --git a/stubs/setup/LICENSE b/stubs/setup/LICENSE deleted file mode 100644 index 7b6b9bc..0000000 --- a/stubs/setup/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -Copyright 2020 Ā© Holt59 - -The MIT License (MIT) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/stubs/setup/README.md b/stubs/setup/README.md deleted file mode 100644 index 04226fa..0000000 --- a/stubs/setup/README.md +++ /dev/null @@ -1,16 +0,0 @@ -mypy logo - -[![PyPI version](https://badge.fury.io/py/mobase-stubs.svg)](https://badge.fury.io/py/mobase-stubs) -[![mypy checked](https://camo.githubusercontent.com/34b3a249cd6502d0a521ab2f42c8830b7cfd03fa/687474703a2f2f7777772e6d7970792d6c616e672e6f72672f7374617469632f6d7970795f62616467652e737667)](http://mypy-lang.org/) - -# Mypy stubs for the mobase Python API - -This repository holds the stubs of the `mobase` python module, which contains the Python plugin -interface for [Mod Organizer 2](https://github.com/modorganizer2/modorganizer) plugins. -It uses the stub files that are produced by https://github.com/ModOrganizer2/pystubs-generation/. - -# Installation - -Simply install `mobase-stubs` with pip: - - $ pip install mobase-stubs diff --git a/stubs/setup/mobase-stubs/.keep b/stubs/setup/mobase-stubs/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/stubs/setup/mobase-stubs/__init__.pyi b/stubs/setup/mobase-stubs/__init__.pyi deleted file mode 100644 index 894f4da..0000000 --- a/stubs/setup/mobase-stubs/__init__.pyi +++ /dev/null @@ -1,3537 +0,0 @@ -__version__ = "2.4.0.alpha1" - -import abc -from enum import Enum -from typing import ( - Dict, - Iterator, - List, - Tuple, - Union, - Any, - Optional, - Callable, - overload, - TypeVar, - Type, -) -import PyQt5.QtCore -import PyQt5.QtGui -import PyQt5.QtWidgets - -MoVariant = Union[None, bool, int, str, List[Any], Dict[str, Any]] -GameFeatureType = TypeVar("GameFeatureType") - -class InterfaceNotImplemented: ... - -def getFileVersion(filepath: str) -> str: - """ - Retrieve the file version of the given executable. - - Args: - filepath: Absolute path to the executable. - - Returns: - The file version, or an empty string if the file version could not be retrieved. - """ - ... - -def getIconForExecutable(executable: str) -> PyQt5.QtGui.QIcon: - """ - Retrieve the icon of an executable. Currently this always extracts the biggest icon. - - Args: - executable: Absolute path to the executable. - - Returns: - The icon for this executable, if any. - """ - ... - -def getProductVersion(executable: str) -> str: - """ - Retrieve the product version of the given executable. - - Args: - executable: Absolute path to the executable. - - Returns: - The product version, or an empty string if the product version could not be retrieved. - """ - ... - -class GuessQuality(Enum): - """ - Describes how good the code considers a guess (i.e. for a mod name) this is used to - determine if a name from another source should overwrite or not. - """ - - INVALID = ... - FALLBACK = ... - GOOD = ... - META = ... - PRESET = ... - USER = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class InstallResult(Enum): - SUCCESS = ... - FAILED = ... - CANCELED = ... - MANUAL_REQUESTED = ... - NOT_ATTEMPTED = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class LoadOrderMechanism(Enum): - FILE_TIME = ... - PLUGINS_TXT = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class ModState(Enum): - EXISTS = ... - ACTIVE = ... - ESSENTIAL = ... - EMPTY = ... - ENDORSED = ... - VALID = ... - ALTERNATE = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class PluginState(Enum): - MISSING = ... - INACTIVE = ... - ACTIVE = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class ProfileSetting(Enum): - MODS = ... - CONFIGURATION = ... - SAVEGAMES = ... - PREFER_DEFAULTS = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class ReleaseType(Enum): - PRE_ALPHA = ... - ALPHA = ... - BETA = ... - CANDIDATE = ... - FINAL = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class SortMechanism(Enum): - NONE = ... - MLOX = ... - BOSS = ... - LOOT = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class VersionScheme(Enum): - DISCOVER = ... - REGULAR = ... - DECIMAL_MARK = ... - NUMBERS_AND_LETTERS = ... - DATE = ... - LITERAL = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - -class BSAInvalidation(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def activate(self, profile: "IProfile"): ... - @abc.abstractmethod - def deactivate(self, profile: "IProfile"): ... - @abc.abstractmethod - def isInvalidationBSA(self, name: str) -> bool: ... - -class DataArchives(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def addArchive(self, profile: "IProfile", index: int, name: str): - """ - Add an archive to the archive list. - - Args: - profile: Profile to add the archive to. - index: Index to insert before. Use 0 for the beginning of the list or INT_MAX for - the end of the list). - name: Name of the archive to add. - """ - ... - @abc.abstractmethod - def archives(self, profile: "IProfile") -> List[str]: - """ - Retrieve the list of archives in the given profile. - - Args: - profile: Profile to retrieve archives from. - - Returns: - The list of archives in the given profile. - """ - ... - @abc.abstractmethod - def removeArchive(self, profile: "IProfile", name: str): - """ - Remove the given archive from the given profile. - - Args: - profile: Profile to remove the archive from. - name: Name of the archive to remove. - """ - ... - @abc.abstractmethod - def vanillaArchives(self) -> List[str]: - """ - Retrieve the list of vanilla archives. - - Vanilla archives are archive files that are shipped with the original - game. - - Returns: - The list of vanilla archives. - """ - ... - -class ExecutableForcedLoadSetting: - def __init__(self, process: str, library: str): ... - def enabled(self) -> bool: ... - def forced(self) -> bool: ... - def library(self) -> str: ... - def process(self) -> str: ... - def withEnabled(self, enabled: bool) -> "ExecutableForcedLoadSetting": ... - def withForced(self, forced: bool) -> "ExecutableForcedLoadSetting": ... - -class ExecutableInfo: - def __init__(self, title: str, binary: PyQt5.QtCore.QFileInfo): ... - def arguments(self) -> List[str]: ... - def asCustom(self) -> "ExecutableInfo": ... - def binary(self) -> PyQt5.QtCore.QFileInfo: ... - def isCustom(self) -> bool: ... - def isValid(self) -> bool: ... - def steamAppID(self) -> str: ... - def title(self) -> str: ... - def withArgument(self, argument: str) -> "ExecutableInfo": ... - def withSteamAppId(self, app_id: str) -> "ExecutableInfo": ... - def withWorkingDirectory( - self, directory: PyQt5.QtCore.QDir - ) -> "ExecutableInfo": ... - def workingDirectory(self) -> PyQt5.QtCore.QDir: ... - -class FileInfo: - """ - Information about a virtualised file - """ - - @property - def archive(self) -> str: ... - @archive.setter - def archive(self, arg0: str): ... - @property - def filePath(self) -> str: ... - @filePath.setter - def filePath(self, arg0: str): ... - @property - def origins(self) -> List[str]: ... - @origins.setter - def origins(self, arg0: List[str]): ... - def __init__(self): - """ - Creates an uninitialized FileInfo. - """ - ... - -class FileTreeEntry: - """ - Represent an entry in a file tree, either a file or a directory. This class - inherited by IFileTree so that operations on entry are the same for a file or - a directory. - - This class provides convenience methods to query information on the file, like its - name or the its last modification time. It also provides a convenience astree() method - that can be used to retrieve the tree corresponding to its entry in case the entry - represent a directory. - """ - - class FileTypes(Enum): - """ - Enumeration of the different file type or combinations. - """ - - DIRECTORY = ... - FILE = ... - FILE_OR_DIRECTORY = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - DIRECTORY: "FileTreeEntry.FileTypes" = ... - FILE: "FileTreeEntry.FileTypes" = ... - FILE_OR_DIRECTORY: "FileTreeEntry.FileTypes" = ... - @overload - def __eq__(self, arg2: str) -> bool: ... - @overload - def __eq__(self, arg2: "FileTreeEntry") -> bool: ... - @overload - def __eq__(self, other: object) -> bool: ... - def __repr__(self) -> str: ... - def detach(self) -> bool: - """ - Detach this entry from its parent tree. - - Returns: - True if the entry was removed correctly, False otherwize. - """ - ... - def fileType(self) -> "FileTreeEntry.FileTypes": - """ - Returns: - The filetype of this entry. - """ - ... - @overload - def hasSuffix(self, suffixes: List[str]) -> bool: - """ - Check if this entry has one of the given suffixes. - - Args: - suffixes: Suffixes to check. - - Returns: - True if this entry is a file and has one of the given suffix. - """ - ... - @overload - def hasSuffix(self, suffix: str) -> bool: - """ - Check if this entry has the given suffix. - - Args: - suffix: Suffix to check. - - Returns: - True if this entry is a file and has the given suffix. - """ - ... - def isDir(self) -> bool: - """ - Returns: - True if this entry is a directory, False otherwise. - """ - ... - def isFile(self) -> bool: - """ - Returns: - True if this entry is a file, False otherwise. - """ - ... - def moveTo(self, tree: "IFileTree") -> bool: - """ - Move this entry to the given tree. - - Args: - tree: The tree to move this entry to. - - Returns: - True if the entry was moved correctly, False otherwize. - """ - ... - def name(self) -> str: - """ - Returns: - The name of this entry. - """ - ... - def parent(self) -> Optional["IFileTree"]: - """ - Returns: - The parent tree containing this entry, or a `None` if this entry is the root - or the parent tree is unreachable. - """ - ... - def path(self, sep: str = "\\") -> str: - """ - Retrieve the path from this entry up to the root of the tree. - - This method propagate up the tree so is not constant complexity as - the full path is never stored. - - Args: - sep: The type of separator to use to create the path. - - Returns: - The path from this entry to the root, including the name of this entry. - """ - ... - def pathFrom(self, tree: "IFileTree", sep: str = "\\") -> str: - """ - Retrieve the path from the given tree to this entry. - - Args: - tree: The tree to reach, must be a parent of this entry. - sep: The type of separator to use to create the path. - - Returns: - The path from the given tree to this entry, including the name of this entry, or - an empty string if the given tree is not a parent of this entry. - """ - ... - def suffix(self) -> str: - """ - Retrieve the "last" extension of this entry. - - The "last" extension is everything after the last dot in the file name. - - Returns: - The last extension of this entry, or an empty string if the file has no extension - or is directory. - """ - ... - -class GamePlugins(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def getLoadOrder(self) -> List[str]: ... - @abc.abstractmethod - def lightPluginsAreSupported(self) -> bool: - """ - Returns: - True if light plugins are supported, False otherwise. - """ - ... - @abc.abstractmethod - def readPluginLists(self, plugin_list: "IPluginList"): ... - @abc.abstractmethod - def writePluginLists(self, plugin_list: "IPluginList"): ... - -class GuessedString: - """ - Represents a string that may be set from different places. Each time the value is - changed a "quality" is specified to say how probable it is the value is the best choice. - Only the best choice should be used in the end but alternatives can be queried. This - class also allows a filter to be set. If a "guess" doesn't pass the filter, it is ignored. - """ - - @overload - def __init__(self): - """ - Creates a GuessedString with no associated value. - """ - ... - @overload - def __init__(self, value: str, quality: "GuessQuality"): - """ - Creates a GuessedString with the given value and quality. - - Args: - value: Initial value of the GuessedString. - quality: Quality of the initial value. - """ - ... - def __str__(self) -> str: ... - @overload - def reset(self) -> "GuessedString": - """ - Reset this GuessedString to an invalid state. - - Returns: - This GuessedString object. - """ - ... - @overload - def reset(self, value: str, quality: "GuessQuality") -> "GuessedString": - """ - Reset this GuessedString object with the given value and quality, only - if the given quality is better than the current one. - - Args: - value: New value for this GuessedString. - quality: Quality of the new value. - - Returns: - This GuessedString object. - """ - ... - @overload - def reset(self, other: "GuessedString") -> "GuessedString": - """ - Reset this GuessedString object by copying the given one, only - if the given one has better quality. - - Args: - other: The GuessedString to copy. - - Returns: - This GuessedString object. - """ - ... - def setFilter(self, filter: Callable[[str], Union[str, bool]]): - """ - Set the filter for this GuessedString. - - The filter is applied on every `update()` and can reject the new value - altogether or modify it (by returning a new value). - - Args: - filter: The new filter. - """ - ... - @overload - def update(self, value: str) -> "GuessedString": - """ - Update this GuessedString by adding the given value to the list of variants - and setting the actual value without changing the current quality of this - GuessedString. - - The GuessedString is only updated if the given value passes the filter. - - Args: - value: The new value for this string. - - Returns: - This GuessedString object. - """ - ... - @overload - def update(self, value: str, quality: "GuessQuality") -> "GuessedString": - """ - Update this GuessedString by adding a new variants with the given quality. - - If the specified quality is better than the current one, the actual value of - the GuessedString is also updated. - - The GuessedString is only updated if the given value passes the filter. - - Args: - value: The new variant to add. - quality: The quality of the variant. - - Returns: - This GuessedString object. - """ - ... - def variants(self) -> List[str]: - """ - Returns: - The list of variants for this GuessedString. - """ - ... - -class IDownloadManager(PyQt5.QtCore.QObject): - downloadComplete: PyQt5.QtCore.pyqtSignal = ... - downloadPaused: PyQt5.QtCore.pyqtSignal = ... - downloadFailed: PyQt5.QtCore.pyqtSignal = ... - downloadRemoved: PyQt5.QtCore.pyqtSignal = ... - def _object(self) -> PyQt5.QtCore.QObject: - """ - Returns: - The underlying `QObject` for the manager. - """ - ... - def downloadPath(self, id: int) -> str: - """ - Retrieve the (absolute) path of the specified download. - - Args: - id: ID of the download. - - Returns: - The absolute path to the file corresponding to the given download. This file - may not exist yet if the download is incomplete. - """ - ... - def startDownloadNexusFile(self, mod_id: int, file_id: int) -> int: - """ - Download a file from www.nexusmods.com/. is always the game - currently being managed. - - Args: - mod_id: ID of the mod to download the file from. - file_id: ID of the file to download. - - Returns: - An ID identifying the download. - """ - ... - def startDownloadURLs(self, urls: List[str]) -> int: - """ - Download a file by url. - - The list can contain alternative URLs to allow the download manager to switch - in case of download problems - - Args: - urls: List of urls to download from. - - Returns: - An ID identifying the download. - """ - ... - -class IFileTree(FileTreeEntry): - """ - Interface to classes that provides way to visualize and alter file trees. The tree - may not correspond to an actual file tree on the disk (e.g., inside an archive, - from a QTree Widget, ...). - - Read-only operations on the tree are thread-safe, even when the tree has not been populated - yet. - - In order to prevent wrong usage of the tree, implementing classes may throw - UnsupportedOperationException if an operation is not supported. By default, all operations - are supported, but some may not make sense in many situations. - - The goal of this is not reflect the change made to a IFileTree to the disk, but child - classes may override relevant methods to do so. - - The tree is built upon FileTreeEntry. A given tree holds shared pointers to its entries - while each entry holds a weak pointer to its parent, this means that the descending link - are strong (shared pointers) but the uplink are weaks. - - Accessing the parent is always done by locking the weak pointer so that returned pointer - or either null or valid. This structure implies that as long as the initial root lives, - entry should not be destroyed, unless the entry are detached from the root and no shared - pointers are kept. - - However, it is not guarantee that one can go up the tree from a single node entry. If the - root node is destroyed, it will not be possible to go up the tree, even if we still have - a valid shared pointer. - """ - - class InsertPolicy(Enum): - FAIL_IF_EXISTS = ... - REPLACE = ... - MERGE = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - class WalkReturn(Enum): - """ - Enumeration that can be returned by the callback for the `walk()` method to stop the - walking operation early. - """ - - CONTINUE = ... - STOP = ... - SKIP = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - CONTINUE: "IFileTree.WalkReturn" = ... - FAIL_IF_EXISTS: "IFileTree.InsertPolicy" = ... - MERGE: "IFileTree.InsertPolicy" = ... - REPLACE: "IFileTree.InsertPolicy" = ... - SKIP: "IFileTree.WalkReturn" = ... - STOP: "IFileTree.WalkReturn" = ... - def __bool__(self) -> bool: - """ - Returns: - True if this tree is not empty, False otherwise. - """ - ... - def __getitem__(self, index: int) -> "FileTreeEntry": - """ - Retrieve the entry at the given index in this tree. - - Args: - index: Index of the entry to retrieve, must be less than the size. - - Returns: - The entry at the given index. - - Raises: - IndexError: If the given index is not in range for this tree. - """ - ... - def __iter__(self) -> Iterator[FileTreeEntry]: - """ - Retrieves an iterator for entries directly under this tree. - - This method does not recurse into subtrees, see `walk()` for this. - - Returns: - An iterator object that can be used to iterate over entries in this tree. - """ - ... - def __len__(self) -> int: - """ - Returns: - The number of entries directly under this tree. - """ - ... - def __repr__(self) -> str: ... - def addDirectory(self, path: str) -> "IFileTree": - """ - Create a new directory tree under this tree. - - This method will create missing folders in the given path and will - not fail if the directory already exists but will fail if the given - path contains "." or "..". - This method invalidates iterators to this tree and all the subtrees - present in the given path. - - Args: - path: Path to the directory to create. - - Returns: - An IFileTree corresponding to the created directory. - - Raises: - RuntimeError: If the directory could not be created. - """ - ... - def addFile(self, path: str, replace_if_exists: bool = False) -> "FileTreeEntry": - """ - Create a new file directly under this tree. - - This method will fail if the file already exists and `replace_if_exists` is `False`. - This method invalidates iterators to this tree and all the subtrees present in the - given path. - - Args: - path: Path to the file to create. - replace_if_exists: If True and an entry already exists at the given location, it will be replaced by - a new entry. This will replace both files and directories. - - Returns: - A FileTreeEntry corresponding to the created file. - - Raises: - RuntimeError: If the file could not be created. - """ - ... - def clear(self) -> bool: - """ - Delete (detach) all the entries from this tree. - - This method will go through the entries in this tree and stop at the first - entry that cannot be deleted, this means that the tree can be partially cleared. - - Returns: - True if all entries have been detached, False otherwise. - """ - ... - def copy( - self, - entry: "FileTreeEntry", - path: str = "", - policy: "IFileTree.InsertPolicy" = InsertPolicy.FAIL_IF_EXISTS, - ) -> "FileTreeEntry": - """ - Move the given entry to the given path under this tree. - - The entry must not be a parent tree of this tree. This method can also be used - to rename entries. - - If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry - at the same location already exists. If the policy is REPLACE, an existing - entry will be replaced. If MERGE, the entry will be merged with the existing - one (if the entry is a file, and a file exists, the file will be replaced). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - - Args: - entry: Entry to copy. - path: The path to copy the entry to. If the path ends with / or \\, the entry will - be copied in the corresponding directory instead of replacing it. If the - given path is empty (`""`), the entry is copied directly under this tree. - policy: Policy to use to resolve conflicts. - - Returns: - The new entry (copy of the specified entry). - - Raises: - RuntimeError: If the entry could not be copied. - """ - ... - def createOrphanTree(self, name: str = "") -> "IFileTree": - """ - Create a new orphan empty tree. - - Args: - name: Name of the tree. - - Returns: - A new tree without any parent. - """ - ... - def exists( - self, - path: str, - type: "FileTreeEntry.FileTypes" = FileTreeEntry.FileTypes.FILE_OR_DIRECTORY, - ) -> bool: - """ - Check if the given entry exists. - - Args: - path: Path to the entry, separated by / or \\. - type: The type of the entry to check. - - Returns: - True if the entry was found, False otherwise. - """ - ... - def find( - self, - path: str, - type: "FileTreeEntry.FileTypes" = FileTreeEntry.FileTypes.FILE_OR_DIRECTORY, - ) -> Optional[Union["IFileTree", "FileTreeEntry"]]: - """ - Retrieve the given entry. - - If no entry exists at the given path, or if the entry is not of the right - type, `None` is returned. - - Args: - path: Path to the entry, separated by / or \\. - type: The type of the entry to check. - - Returns: - The entry at the given location, or `None` if the entry was not found or - was not of the correct type. - """ - ... - def insert( - self, - entry: "FileTreeEntry", - policy: "IFileTree.InsertPolicy" = InsertPolicy.FAIL_IF_EXISTS, - ) -> bool: - """ - Insert the given entry in this tree, removing it from its - previouis parent. - - The entry must not be this tree or a parent entry of this tree. - - - If the insert policy if `FAIL_IF_EXISTS`, the call will fail if an entry - with the same name already exists. - - If the policy is `REPLACE`, an existing entry will be replaced by the given entry. - - If the policy is `MERGE`: - - - If there is no entry with the same name, the new entry is inserted. - - If there is an entry with the same name: - - - If both entries are files, the old file is replaced by the given entry. - - If both entries are directories, a merge is performed as if using merge(). - - Otherwize the insertion fails (two entries with different types). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - - Args: - entry: Entry to insert. - policy: Policy to use to resolve conflicts. - - Returns: - True if the entry was insert, False otherwise. - """ - ... - def merge( - self, other: "IFileTree", overwrites: bool = False - ) -> Union[Dict["FileTreeEntry", "FileTreeEntry"], int]: - """ - Merge the given tree with this tree, i.e., insert all entries - of the given tree into this tree. - - The tree must not be this tree or a parent entry of this tree. Files present in both tree - will be replaced by files in the given tree. After a merge, the source tree will be - empty but still attached to its parent. - - If `overwrites` is `True`, a map from overriden files to new files will be returned. - - Note that the merge process makes no distinction between files and directories - when merging: if a directory is present in this tree and a file from source - is in conflict with it, the tree will be removed and the file inserted; if a file - is in this tree and a directory from source is in conflict with it, the file will - be replaced with the directory. - - This method invalidates iterators to this tree, all the subtrees under this tree - present in the given path, and all the subtrees of the given source. - - Args: - other: Tree to merge. - overwrites: If True, a mapping from overriden files to new files will be returned. - - Returns: - If `overwrites` is True, a mapping from overriden files to new files, otherwise - the number of overwritten entries. - - Raises: - RuntimeError: If the merge failed. - """ - ... - def move( - self, - entry: "FileTreeEntry", - path: str, - policy: "IFileTree.InsertPolicy" = InsertPolicy.FAIL_IF_EXISTS, - ) -> bool: - """ - Move the given entry to the given path under this tree. - - The entry must not be a parent tree of this tree. This method can also be used - to rename entries. - - If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry - at the same location already exists. If the policy is REPLACE, an existing - entry will be replaced. If MERGE, the entry will be merged with the existing - one (if the entry is a file, and a file exists, the file will be replaced). - - This method invalidates iterator to this tree, to the parent tree of the given - entry, and to subtrees of this tree if the insert policy is MERGE. - - Args: - entry: Entry to move. - path: The path to move the entry to. If the path ends with / or \\, the entry will - be inserted in the corresponding directory instead of replacing it. If the - given path is empty (`""`), this is equivalent to `insert()`. - policy: Policy to use to resolve conflicts. - - Returns: - True if the entry was moved correctly, False otherwise. - """ - ... - def pathTo(self, entry: "FileTreeEntry", sep: str = "\\") -> str: - """ - Retrieve the path from this tree to the given entry. - - Args: - entry: The entry to reach, must be in this tree. - sep: The type of separator to use to create the path. - - Returns: - The path from this tree to the given entry, including the name of the entry, or - an empty string if the given entry was not found under this tree. - """ - ... - @overload - def remove(self, name: str) -> bool: - """ - Delete the entry with the given name. - - This method does not recurse into subtrees, so the entry should be - accessible directly from this tree. - - Args: - name: Name of the entry to delete. - - Returns: - True if the entry was deleted, False otherwise. - """ - ... - @overload - def remove(self, entry: "FileTreeEntry") -> bool: - """ - Delete the given entry. - - Args: - entry: Entry to delete. The entry must belongs to this tree (and not to a subtree). - - Returns: - True if the entry was deleted, False otherwise. - """ - ... - def removeAll(self, names: List[str]) -> int: - """ - Delete the entries with the given names from the tree. - - This method does not recurse into subtrees, so only entries accessible - directly from this tree will be removed. This method invalidates iterators. - - Args: - names: Names of the entries to delete. - - Returns: - The number of deleted entry. - """ - ... - def removeIf(self, filter: Callable[["FileTreeEntry"], bool]) -> int: - """ - Delete entries matching the given predicate from the tree. - - This method does not recurse into subtrees, so only entries accessible - directly from this tree will be removed. This method invalidates iterators. - - Args: - filter: Predicate that should return true for entries to delete. - - Returns: - The number of deleted entry. - """ - ... - def walk( - self, - callback: Callable[[str, "FileTreeEntry"], "IFileTree.WalkReturn"], - sep: str = "\\", - ): - """ - Walk this tree, calling the given function for each entry in it. - - The given callback will be called with two parameters: the path from this tree to the given entry - (with a trailing separator, not including the entry name), and the actual entry. The method returns - a `WalkReturn` object to indicates what to do. - - Args: - callback: Method to call for each entry in the tree. - sep: Type of separator to use to construct the path. - """ - ... - -class IInstallationManager: - def createFile(self, entry: "FileTreeEntry") -> str: - """ - Create a new file on the disk corresponding to the given entry. - - This method can be used by installer that needs to create files that are not in the original - archive. At the end of the installation, if there are entries in the final tree that were used - to create files, the corresponding files will be moved to the mod folder. - - Temporary files corresponding to created files are automatically cleaned up at the end of - the installation. - - Args: - entry: The entry for which a temporary file should be created. - - Returns: - The path to the created file, or an empty string if the file could not be created. - """ - ... - def extractFile(self, entry: "FileTreeEntry", silent: bool = False) -> str: - """ - Extract the specified file from the currently opened archive to a temporary - location. - - This method cannot be used to extract directory. - - The call will fail with an exception if no archive is open (plugins deriving from - IPluginInstallerSimple can rely on that, custom installers should not). The temporary - file is automatically cleaned up after the installation. This call can be very slow - if the archive is large and "solid". - - Args: - entry: Entry corresponding to the file to extract. - silent: If true, the dialog showing extraction progress will not be shown. - - Returns: - The absolute path to the temporary file, or an empty string if the file was not extracted. - """ - ... - def extractFiles( - self, entries: List["FileTreeEntry"], silent: bool = False - ) -> List[str]: - """ - Extract the specified files from the currently opened archive to a temporary - location. - - This method cannot be used to extract directories. - - The call will fail with an exception if no archive is open (plugins deriving from - IPluginInstallerSimple can rely on that, custom installers should not). The temporary - files are automatically cleaned up after the installation. This call can be very slow - if the archive is large and "solid". - - Args: - entries: Entries corresponding to the files to extract. - silent: If true, the dialog showing extraction progress will not be shown. - - Returns: - A list containing absolute paths to the temporary files. - """ - ... - def getSupportedExtensions(self) -> List[str]: - """ - Returns: - The extensions of archives supported by this installation manager. - """ - ... - def installArchive( - self, mod_name: "GuessedString", archive: str, mod_id: int - ) -> "InstallResult": - """ - Install the given archive. - - Args: - mod_name: Suggested name of the mod. - archive: Path to the archive to install. - mod_id: ID of the mod, if available. - - Returns: - The result of the installation. - """ - ... - def setURL(self, url: str): - """ - Set the url associated with the mod being installed. - - Args: - url: Url to set. - """ - ... - -class IModInterface: - def absolutePath(self) -> str: - """ - Returns: - Absolute path to the mod to be used in file system operations. - """ - ... - def addCategory(self, name: str): - """ - Assign a category to the mod. If the named category does not exist it is created. - - Args: - name: Name of the new category to assign. - """ - ... - def addNexusCategory(self, category_id: int): - """ - Set the category id from a nexus category id. Conversion to MO ID happens internally. - - If a mapping is not possible, the category is set to the default value. - - Args: - category_id: The Nexus category ID. - """ - ... - def categories(self) -> List[str]: - """ - Returns: - The list of categories assigned to this mod. - """ - ... - def name(self) -> str: - """ - Returns: - The name of this mod. - """ - ... - def remove(self) -> bool: - """ - Delete the mod from the disc. - - This does not update the global ModInfo structure or indices. - - Returns: - True if the mod was deleted, False otherwise. - """ - ... - def removeCategory(self, name: str) -> bool: - """ - Unassign a category from this mod. - - Args: - name: Name of the category to remove. - - Returns: - True if the category was removed, False otherwise (e.g. if no such category - was assigned). - """ - ... - def setGameName(self, name: str): - """ - Set the source game of this mod. - - Args: - name: The new source game short name of this mod. - """ - ... - def setIsEndorsed(self, endorsed: bool): - """ - Set endorsement state of the mod. - - Args: - endorsed: New endorsement state of this mod. - """ - ... - def setName(self, name: str) -> bool: - """ - Set the name of this mod. - - This will also update the name of the directory that contains this mod - - Args: - name: New name for this mod. - - Returns: - True if the name was changed, False if an error occured (e.g. if the name is not a valid - directory name). - """ - ... - def setNewestVersion(self, version: "VersionInfo"): - """ - Set the latest known version of this mod. - - Args: - version: The latest known version of this mod. - """ - ... - def setNexusID(self, nexus_id: int): - """ - Set the Nexus ID of this mod. - - Args: - nexus_id: Thew new Nexus ID of this mod. - """ - ... - def setVersion(self, version: "VersionInfo"): - """ - Set the version of this mod. - - Args: - version: The new version of this mod. - """ - ... - -class IModList: - """ - Interface to the mod-list. - - All api functions in this interface work need the internal name of a mod to find a - mod. For regular mods (mods the user installed) the display name (as shown to the user) - and internal name are identical. For other mods (non-MO mods) there is currently no way - to translate from display name to internal name because the display name might not me un-ambiguous. - """ - - def allMods(self) -> List[str]: - """ - Returns: - A list containing the internal names of all installed mods. - """ - ... - def displayName(self, name: str) -> str: - """ - Retrieve the display name of a mod from its internal name. - - If you received an internal name from the API (e.g. `IPluginList.origin`) then you should use - that name to identify the mod in all other api calls but use this function to retrieve the name - to show to the user. - - Args: - name: Internal name of the mod. - - Returns: - The display name of the given mod. - """ - ... - def onModMoved(self, callback: Callable[[str, int, int], None]) -> bool: - """ - Install a handler to be called when a mod is moved. - - Args: - callback: The function to call when a mod is moved. The first argument is the internal name of the - mod, the second argument the old priority and the third argument the new priority. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onModStateChanged(self, callback: Callable[[Dict[str, int]], None]) -> bool: - """ - Install a handler to be called when mod states change (enabled/disabled, endorsed, ...). - - Args: - callback: The function to call when the states of mod change. The argument is a map containing the - mods whose states have changed. Keys are internal mod names and values are mod states. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def priority(self, name: str) -> int: - """ - Retrieve the priority of a mod. - - Args: - name: Internal name of the mod. - - Returns: - The priority of the given mod. - """ - ... - @overload - def setActive(self, names: List[str], active: bool) -> int: - """ - Enable or disable a list of mods. - - Calling this will cause MO to re-evaluate its virtual file system so this is - a fairly expensive call. - - Args: - names: Internal names of the mod to enable or disable. - active: True to enable the mods, False to disable them. - - Returns: - True on success, False otherwise. - """ - ... - @overload - def setActive(self, name: str, active: bool) -> bool: - """ - Enable or disable a mod. - - Calling this will cause MO to re-evaluate its virtual file system so this is - a fairly expensive call. - - Args: - name: Internal name of the mod to enable or disable. - active: True to enable the mod, False to disable it. - - Returns: - True on success, False otherwise. - """ - ... - def setPriority(self, name: str, priority: int) -> bool: - """ - Change the priority of a mod. - - `priority` is the new priority after the move. Keep in mind that the mod disappears from its - old location and all mods with higher priority than the moved mod decrease in priority by one. - - Args: - name: Internal name of the mod. - priority: The new priority of the mod. - - Returns: - True if the priority was changed, False otherwise (if the name or priority were invalid). - """ - ... - def state(self, name: str) -> int: - """ - Retrieve the state of a mod. - - Args: - name: Internal name of the mod. - - Returns: - The state of the given mod. - """ - ... - -class IModRepositoryBridge(PyQt5.QtCore.QObject): - descriptionAvailable: PyQt5.QtCore.pyqtSignal = ... - filesAvailable: PyQt5.QtCore.pyqtSignal = ... - fileInfoAvailable: PyQt5.QtCore.pyqtSignal = ... - downloadURLsAvailable: PyQt5.QtCore.pyqtSignal = ... - endorsementsAvailable: PyQt5.QtCore.pyqtSignal = ... - endorsementToggled: PyQt5.QtCore.pyqtSignal = ... - trackedModsAvailable: PyQt5.QtCore.pyqtSignal = ... - trackingToggled: PyQt5.QtCore.pyqtSignal = ... - requestFailed: PyQt5.QtCore.pyqtSignal = ... - def _object(self) -> PyQt5.QtCore.QObject: - """ - Returns: - The underlying `QObject` for the bridge. - """ - ... - def requestDescription(self, game_name: str, mod_id: int, user_data: MoVariant): - """ - Request description of a mod. - - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - user_data: User data to be returned with the result. - """ - ... - def requestDownloadURL( - self, game_name: str, mod_id: int, file_id: int, user_data: MoVariant - ): - """ - Request download URL for mod file.0 - - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - file_id: ID of the file for which a URL should be returned. - user_data: User data to be returned with the result. - """ - ... - def requestFileInfo( - self, game_name: str, mod_id: int, file_id: int, user_data: MoVariant - ): - """ - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - file_id: ID of the file for which information is requested. - user_data: User data to be returned with the result. - """ - ... - def requestFiles(self, game_name: str, mod_id: int, user_data: MoVariant): - """ - Request the list of files belonging to a mod. - - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - user_data: User data to be returned with the result. - """ - ... - def requestToggleEndorsement( - self, - game_name: str, - mod_id: int, - mod_version: str, - endorse: bool, - user_data: MoVariant, - ): - """ - Args: - game_name: Name of the game containing the mod. - mod_id: Nexus ID of the mod. - mod_version: Version of the mod. - endorse: - user_data: User data to be returned with the result. - """ - ... - -class IOrganizer: - """ - Interface to class that provides information about the running session - of Mod Organizer to be used by plugins. - """ - - def appVersion(self) -> "VersionInfo": - """ - Returns: - The running version of Mod Organizer. - """ - ... - def basePath(self) -> str: - """ - Returns: - The absolute path to the base directory of Mod Organizer. - """ - ... - def createMod(self, name: "GuessedString") -> "IModInterface": - """ - Create a new mod with the specified name. - - If a mod with the same name already exists, the user will be queried. If the user chooses - to merge or replace, the call will succeed, otheriwse the call will fail. - - Args: - name: Name of the mod to create. - - Returns: - An interface to the newly created mod that can be used to modify it, or `None` if the mod - could not be created. - """ - ... - def createNexusBridge(self) -> "IModRepositoryBridge": - """ - Create a new Nexus interface. - - Returns: - The newly created Nexus interface. - """ - ... - def downloadManager(self) -> "IDownloadManager": - """ - Returns: - The interface to the download manager. - """ - ... - def downloadsPath(self) -> str: - """ - Returns: - The absolute path to the download directory. - """ - ... - def findFileInfos( - self, path: str, filter: Callable[["FileInfo"], bool] - ) -> List["FileInfo"]: - """ - Find files in the virtual directory matching the specified filter. - - Args: - path: The path to search in (relative to the 'data' folder). - filter: The function to use to filter files. Should return True for the files to keep. - - Returns: - The list of `QFileInfo` corresponding to the matching files. - """ - ... - @overload - def findFiles(self, path: str, filter: Callable[[str], bool]) -> List[str]: - """ - Find files in the given folder that matches the given filter. - - Args: - path: The path to search in (relative to the 'data' folder). - filter: The function to use to filter files. Should return True for the files to keep. - - Returns: - The list of matching files. - """ - ... - @overload - def findFiles(self, path: str, patterns: List[str]) -> List[str]: - """ - Find files in the given folder that matches one of the given glob patterns. - - Args: - path: The path to search in (relative to the 'data' folder). - patterns: List of glob patterns to match against. - - Returns: - The list of matching files. - """ - ... - @overload - def findFiles(self, path: str, pattern: str) -> List[str]: - """ - Find files in the given folder that matches the given glob pattern. - - Args: - path: The path to search in (relative to the 'data' folder). - pattern: The glob pattern to use to filter files. - - Returns: - The list of matching files. - """ - ... - def getFileOrigins(self, filename: str) -> List[str]: - """ - Retrieve the file origins for the speicified file. - - The origins are listed with their internal name. The internal name of a mod can differ - from the display name for disambiguation. - - Args: - filename: Path to the file to retrieve origins for (relative to the 'data' folder). - - Returns: - The list of origins that contain the specified file, sorted by their priority. - """ - ... - def getGame(self, name: str) -> "IPluginGame": - """ - Retrieve the game plugin matching the given name. - - Args: - name: Name of the game (short name). - - Returns: - The plugin for the given game, or `None` if none was found. - """ - ... - def getMod(self, name: str) -> "IModInterface": - """ - Retrieve an interface to a mod using its name. - - Args: - name: Name of the mod to retrieve. - - Returns: - An interface to the given mod, or `None` if there is no mod with this name - """ - ... - def installMod(self, filename: str, name_suggestion: str = "") -> "IModInterface": - """ - Install a mod archive at the specified location. - - Args: - filename: Absolute filepath to the archive to install. - name_suggestion: Suggested name for this mod. This can still be changed by the user. - - Returns: - An interface to the new installed mod, or `None` if no installation took place (canceled or failure). - """ - ... - def listDirectories(self, directory: str) -> List[str]: - """ - Retrieve the list of (virtual) subdirectories in the given path. - - Args: - directory: Path to the directory to list (relative to the 'data' folder). - - Returns: - The list of directories in the given directory. - """ - ... - def managedGame(self) -> "IPluginGame": - """ - Returns: - The plugin corresponding to the current game. - """ - ... - def modDataChanged(self, mod: "IModInterface"): - """ - Notify the organizer that the given mod has changed. - - Args: - mod: The mod that has changed. - """ - ... - def modList(self) -> "IModList": - """ - Returns: - The interface to the mod list. - """ - ... - def modsPath(self) -> str: - """ - Returns: - The (absolute) path to the mods directory. - """ - ... - def modsSortedByProfilePriority(self) -> List[str]: - """ - Returns: - The list of mod (names), sorted according to the current profile priorities. - """ - ... - def onAboutToRun(self, callback: Callable[[str], bool]) -> bool: - """ - Install a new handler to be called when an application is about to run. - - Multiple handlers can be installed. If any of the handler returns `False`, the application will - not run. - - Args: - callback: The function to call when an application is about to run. The parameter is the absolute path - to the application to run. The function can return False to prevent the application from running. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onFinishedRun(self, callback: Callable[[str, int], None]) -> bool: - """ - Install a new handler to be called when an application has finished running. - - Args: - callback: The function to call when an application has finished running. The first parameter is the absolute - path to the application, and the second parameter is the exit code of the application. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onModInstalled(self, callback: Callable[[str], None]) -> bool: - """ - Install a new handler to be called when a new mod is installed. - - Args: - callback: The function to call when a mod is installed. The parameter of the function is the name of the - installed mod. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onPluginSettingChanged( - self, callback: Callable[[str, str, MoVariant, MoVariant], None] - ) -> bool: - """ - Install a new handler to be called when a plugin setting is changed. - - Args: - callback: The function to call when a plugin setting is changed. The parameters are: The name of the plugin, the - name of the setting, the old value (or `None` if the setting did not exist before) and the new value - of the setting (or `None` if the setting has been removed). - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onProfileChanged( - self, callback: Callable[["IProfile", "IProfile"], None] - ) -> bool: - """ - Install a new handler to be called when the current profile is changed. - - The function is called when the profile is changed but some operations related to - the profile might not be finished when this is called (e.g., the virtual file system - might not be up-to-date). - - Args: - callback: The function to call when the current profile is changed. The first parameter is the old profile (can - be `None`, e.g. at startup), and the second parameter is the new profile (cannot be `None`). - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onUserInterfaceInitialized( - self, callback: Callable[[PyQt5.QtWidgets.QMainWindow], None] - ) -> bool: - """ - Install a new handler to be called when the UI has been fully initialized. - - Args: - callback: The function to call when the user-interface has been fully initialized. The parameter is the main - window of the application (`QMainWindow`). - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def overwritePath(self) -> str: - """ - Returns: - The (absolute) path to the overwrite directory. - """ - ... - def persistent( - self, plugin_name: str, key: str, default: MoVariant = None - ) -> MoVariant: - """ - Retrieve the specified persistent value for a plugin. - - A persistent is an arbitrary value that the plugin can set and retrieve that is persistently stored - by the main application. There is no UI for the user to change this value but they can directly access - the storage - - Args: - plugin_name: Name of the plugin for which to retrieve the value. This should always be IPlugin::name() unless you have a - really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - default: Default value to return if the key is not set (yet). - - Returns: - The value corresponding to the given persistent setting, or `def` is the key is not found. - """ - ... - def pluginDataPath(self) -> str: - """ - Retrieve the path to a directory where plugin data should be stored. - - For python plugins, it is recommended to use a dedicated folder (per plugin) if you need to - store data (resources, or multiple python files). - - Returns: - Path to a directory where plugin data should be stored. - """ - ... - def pluginList(self) -> "IPluginList": - """ - Returns: - The plugin list interface. - """ - ... - def pluginSetting(self, plugin_name: str, key: str) -> MoVariant: - """ - Retrieve settings of plugins. - - Args: - plugin_name: Name of the plugin to retrieve the setting for. - key: Name of the setting to retrieve the value for. - - Returns: - The value of the setting. - """ - ... - def profile(self) -> "IProfile": - """ - Returns: - The interface to the current profile. - """ - ... - def profileName(self) -> str: - """ - Returns: - The name of the current profile, or an empty string if no profile has been loaded (yet). - """ - ... - def profilePath(self) -> str: - """ - Returns: - The absolute path to the active profile or an empty string if no profile has been loaded (yet). - """ - ... - def refreshModList(self, save_changes: bool = True): - """ - Refresh the mod list. - - Args: - save_changes: If True, the relevant profile information is saved first (enabled mods and order of mods). - """ - ... - def removeMod(self, mod: "IModInterface") -> bool: - """ - Remove a mod (from disc and from the UI). - - Args: - mod: The mod to remove. - - Returns: - True if the mod was removed, False otherwise. - """ - ... - def resolvePath(self, filename: str) -> str: - """ - Resolves a path relative to the virtual data directory to its absolute real path. - - Args: - filename: Path to resolve. - - Returns: - The absolute real path, or an empty string if the path was not found. - """ - ... - def setPersistent( - self, plugin_name: str, key: str, value: MoVariant, sync: bool = True - ): - """ - Set the specified persistent value for a plugin. - - This does not update the in-memory value for this setting, see `setPluginSetting()` for this. - - Args: - plugin_name: Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a - really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - value: New value for the setting. - sync: If True, the storage is immediately written to disc. This costs performance but is safer against data loss. - """ - ... - def setPluginSetting(self, plugin_name: str, key: str, value: MoVariant): - """ - Set the specified setting for a plugin. - - This automatically notify handlers register with `onPluginSettingChanged`, so you do not have to do it yourself. - - Args: - plugin_name: Name of the plugin for which to change a value. This should always be IPlugin::name() unless you have a - really good reason to access data of another mod AND if you can verify that plugin is actually installed. - key: Identifier of the setting. - value: New value for the setting. - """ - ... - def startApplication( - self, - executable: str, - args: List[str] = [], - cwd: str = "", - profile: str = "", - forcedCustomOverwrite: str = "", - ignoreCustomOverwrite: bool = False, - ) -> int: - """ - Starts an application with virtual filesystem active. - - Args: - executable: Name or path of the executable. If this is only a filename, it will only work if it has been configured - in MO as an executable. If it is a relative path it is expected to be relative to the game directory. - args: Arguments to pass to the executable. If the list is empty, and `executable` refers to a configured executable, - the configured arguments are used. - cwd: The working directory for the executable. If this is empty, the path to the executable is used unless `executable` - referred to a configured MO executable, in which case the configured cwd is used. - profile: Profile to use. If this is empty (the default) the current profile is used. - forcedCustomOverwrite: The mod to set as the custom overwrite, regardless of what the profile has configured. - ignoreCustomOverwrite: Set to true to ignore the profile's configured custom overwrite. - - Returns: - The handle to the started application, or 0 if the application failed to start. - """ - ... - def waitForApplication(self, handle: int) -> Tuple[bool, int]: - """ - Wait for the application corresponding to the given handle to finish. - - This will always show the lock overlay, regardless of whether the - user has disabled locking in the setting, so use this with care. - Note that the lock overlay will always allow the user to unlock, in - which case this will return False. - - Args: - handle: Handle of the application to wait for (as returned by `startApplication()`). - - Returns: - A tuple `(result, exitcode)`, where `result` is a boolean indicating if the application - completed successfully, and `exitcode` is the exit code of the application. - """ - ... - -class IPlugin(abc.ABC): - """ - Base class for all plugins. - """ - - def __init__(self): ... - @abc.abstractmethod - def author(self) -> str: - """ - Returns: - The name of the plugin author. - """ - ... - @abc.abstractmethod - def description(self) -> str: - """ - Returns: - The description for this plugin. - """ - ... - @abc.abstractmethod - def init(self, organizer: "IOrganizer") -> bool: - """ - Initialize this plugin. - - Args: - organizer: The main organizer interface. - - Returns: - True if the plugin was initialized correctly, False otherwise. - """ - ... - @abc.abstractmethod - def isActive(self) -> bool: - """ - Check if this plugin is active. - - It is possible to use a plugin setting (specified in `settings()`) here to allow - users to manually enable/disable a plugin. - - Returns: - True if this plugin is active, False otherwise. - """ - ... - @abc.abstractmethod - def name(self) -> str: - """ - Retrieve the name of the plugin. - - The name of the plugin is used for internal storage purpose so it should not change, - and it should be static. In particular, you should not use a localized string (`tr()`) - for the plugin name. - - In the future, we will provide a way to localized plugin names using a distinct method, - such as `localizedName()`. - - Returns: - The name of the plugin. - """ - ... - @abc.abstractmethod - def settings(self) -> List["PluginSetting"]: - """ - Returns: - A list of settings for this plugin. - """ - ... - @abc.abstractmethod - def version(self) -> "VersionInfo": - """ - Returns: - The version of this plugin. - """ - ... - -class IPluginDiagnose(IPlugin): - """ - Plugins that create problem reports to be displayed in the UI. - - This can be used to report problems related to the same plugin (which implements further - interfaces) or as a stand-alone diagnosis tool. - """ - - def __init__(self): ... - def _invalidate(self): - """ - Invalidate the problems corresponding to this plugin. - """ - ... - @abc.abstractmethod - def activeProblems(self) -> List[int]: - """ - Retrieve the list of active problems found by this plugin. - - This method returns a list of problem IDs, that are then used when calling other methods - such as `shortDescription()` or `hasGuidedFix()`. - - Returns: - The list of active problems for this plugin. - """ - ... - @abc.abstractmethod - def fullDescription(self, key: int) -> str: - """ - Retrieve the full description of the problem corresponding to the given key. - - Args: - key: ID of the problem. - - Returns: - The full description of the problem. - - Raises: - IndexError: If the key is not valid. - """ - ... - @abc.abstractmethod - def hasGuidedFix(self, key: int) -> bool: - """ - Check if the problem corresponding to the given key has a guided fix. - - Args: - key: ID of the problem. - - Returns: - True if there is a guided fix for the problem, False otherwise. - - Raises: - IndexError: If the key is not valid. - """ - ... - @abc.abstractmethod - def shortDescription(self, key: int) -> str: - """ - Retrieve the short description of the problem corresponding to the given key. - - Args: - key: ID of the problem. - - Returns: - The short description of the problem. - - Raises: - IndexError: If the key is not valid. - """ - ... - @abc.abstractmethod - def startGuidedFix(self, key: int): - """ - Starts a guided fix for the problem corresponding to the given key. - - This method should throw `ValueError` if there is no guided fix for the corresponding - problem. - - Args: - key: ID of the problem. - - Raises: - IndexError: If the key is not valid. - ValueError: If there is no guided fix for this problem. - """ - ... - -class IPluginFileMapper(IPlugin): - """ - Plugins that adds virtual file links. - """ - - def __init__(self): ... - @abc.abstractmethod - def mappings(self) -> List["Mapping"]: - """ - Returns: - Mapping for the virtual file system (VFS). - """ - ... - -class IPluginGame(IPlugin): - """ - Base classes for game plugins. - - Each game requires a specific game plugin. These plugins were initially designed for - Bethesda games, so a lot of methods and attributes are irrelevant for other games. If - you wish to write a plugin for a much simpler game, please consider the `basic_games` - plugin: https://github.com/ModOrganizer2/modorganizer-basic_games - """ - - def __init__(self): ... - @abc.abstractmethod - def CCPlugins(self) -> List[str]: - """ - Returns: - The current list of active Creation Club plugins. - """ - ... - @abc.abstractmethod - def DLCPlugins(self) -> List[str]: - """ - Returns: - The list of esp/esm files that are part of known DLCs. - """ - ... - @abc.abstractmethod - def binaryName(self) -> str: - """ - Returns: - The name of the default executable to run (relative to the game folder). - """ - ... - @abc.abstractmethod - def dataDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The name of the directory containing data (relative to the game folder). - """ - ... - @abc.abstractmethod - def documentsDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The directory of the documents folder where configuration files and such for this game reside. - """ - ... - @abc.abstractmethod - def executableForcedLoads(self) -> List["ExecutableForcedLoadSetting"]: - """ - Returns: - A list of automatically discovered libraries that can be force loaded with executables. - """ - ... - @abc.abstractmethod - def executables(self) -> List["ExecutableInfo"]: - """ - Returns: - A list of automatically discovered executables of the game itself and tools surrounding it. - """ - ... - def feature(self, feature_type: Type[GameFeatureType]) -> GameFeatureType: - """ - Retrieve a specified game feature from this plugin. - - Args: - feature_type: The class of feature to retrieve. - - Returns: - The game feature corresponding to the given type, or `None` if the feature is - not implemented. - """ - ... - def featureList(self) -> Dict[Type[GameFeatureType], GameFeatureType]: - """ - Retrieve the list of game features implemented for this plugin. - - Python plugin should not implement this method but `_featureList()`. - - Returns: - A mapping from feature type to actual game features. - """ - ... - @abc.abstractmethod - def gameDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The directory containing the game installation. - """ - ... - @abc.abstractmethod - def gameIcon(self) -> PyQt5.QtGui.QIcon: - """ - Returns: - The icon representing the game. - """ - ... - @abc.abstractmethod - def gameName(self) -> str: - """ - Returns: - The name of the game (as displayed to the user). - """ - ... - @abc.abstractmethod - def gameNexusName(self) -> str: - """ - Returns: - The name of the game identifier for Nexus. - """ - ... - @abc.abstractmethod - def gameShortName(self) -> str: - """ - Returns: - The short name of the game. - """ - ... - @abc.abstractmethod - def gameVariants(self) -> List[str]: - """ - Retrieve the list of variants for this game. - - If there are multiple variants of a game (and the variants make a difference to the - plugin), like a regular one and a GOTY-edition, the plugin can return a list of them - and the user gets to chose which one he owns. - - Returns: - The list of variants of the game. - """ - ... - @abc.abstractmethod - def gameVersion(self) -> str: - """ - Returns: - The version of the game. - """ - ... - @abc.abstractmethod - def getLauncherName(self) -> str: - """ - Returns: - The name of the launcher executable to run (relative to the game folder), or an - empty string if there is no launcher. - """ - ... - @abc.abstractmethod - def iniFiles(self) -> List[str]: - """ - Returns: - The list of INI files this game uses. The first file in the list should be the - 'main' INI file. - """ - ... - @abc.abstractmethod - def initializeProfile(self, directory: PyQt5.QtCore.QDir, settings: int): - """ - Initialize a profile for this game. - - The MO app does not yet support virtualizing only specific aspects but plugins should be written - with this future functionality in mind. - - This function will be used to initially create a profile, potentially to repair it or upgrade/downgrade - it so the implementations have to gracefully handle the case that the directory already contains files. - - Args: - directory: The directory where the profile is to be initialized. - settings: The parameters for how the profile should be initialized. - """ - ... - @abc.abstractmethod - def isInstalled(self) -> bool: - """ - Returns: - True if this game has been discovered as installed, False otherwise. - """ - ... - @abc.abstractmethod - def loadOrderMechanism(self) -> "LoadOrderMechanism": - """ - Returns: - The load order mechanism used by this game. - """ - ... - @abc.abstractmethod - def looksValid(self, directory: PyQt5.QtCore.QDir) -> bool: - """ - Check if the given directory looks like a valid game installation. - - Args: - directory: Directory to check. - - Returns: - True if the directory looks like a valid installation of this game, False otherwise. - """ - ... - @abc.abstractmethod - def nexusGameID(self) -> int: - """ - Retrieve the Nexus game ID for this game. - - Example: For Skyrim, the Nexus game ID is 110. - - Returns: - The Nexus game ID for this game. - """ - ... - @abc.abstractmethod - def nexusModOrganizerID(self) -> int: - """ - Retrieve the Nexus mod ID of Mod Organizer for this game. - - Example: For Skyrim SE, the mod ID of MO2 is 6194. You can find the mod ID in the URL: - https://www.nexusmods.com/skyrimspecialedition/mods/6194 - - Returns: - The Nexus mod ID of Mod Organizer for this game. - """ - ... - @abc.abstractmethod - def primaryPlugins(self) -> List[str]: - """ - Returns: - The list of plugins that are part of the game and not considered optional. - """ - ... - @abc.abstractmethod - def primarySources(self) -> List[str]: - """ - Retrieve primary alternative 'short' names for this game. - - This is used to determine if a Nexus (or other) download source should be considered - as a primary source for the game so that it is not flagged as an alternative one. - - Returns: - The list of primary alternative 'short' names for this game, or an empty list. - """ - ... - @abc.abstractmethod - def savegameExtension(self) -> str: - """ - Returns: - The file extension of save games for this game. - """ - ... - @abc.abstractmethod - def savegameSEExtension(self) -> str: - """ - Returns: - The file extension of Script Extender saves for this game. - """ - ... - @abc.abstractmethod - def savesDirectory(self) -> PyQt5.QtCore.QDir: - """ - Returns: - The directory where save games are stored. - """ - ... - @abc.abstractmethod - def setGamePath(self, path: str): - """ - Set the path to the managed game. - - This is called during instance creation if the game is not auto-detected and the user has - to specify the installation location. This is not called if the game has been auto-detected, - so `isInstalled()` should call this. - - Args: - path: Path to the game installation. - """ - ... - @abc.abstractmethod - def setGameVariant(self, variant: str): - """ - Set the game variant. - - If there are multiple variants of game (as returned by `gameVariants()`), this will be - called on start with the user-selected game variant. - - Args: - variant: The game variant selected by the user. - """ - ... - @abc.abstractmethod - def sortMechanism(self) -> "SortMechanism": - """ - Returns: - The sort mechanism for this game. - """ - ... - @abc.abstractmethod - def steamAPPId(self) -> str: - """ - Retrieve the Steam app ID for this game. - - If the game is not available on Steam, this should return an empty string. - - If a game is available in multiple versions, those might have different app ids. The plugin - should try to return the right one - - Returns: - The Steam app ID for this game. Should be empty for games not available on steam. - """ - ... - @abc.abstractmethod - def validShortNames(self) -> List[str]: - """ - Retrieve the valid 'short' names for this game. - - This is used to determine if a Nexus download is valid for the current game since not all - game variants have their own nexus pages and others can handle downloads from other nexus - game pages and should be allowed to do so (e.g., you can install some Skyrim LE mod even - when using Skyrim SE). - - The short name should be considered the primary handler for a directly supported game - for puroses of auto-launching an instance. - - Returns: - The list of valid short names for this game. - """ - ... - -class IPluginInstaller(IPlugin): - """ - This is the top-level class for installer. Actual installers should inherit either: - - - `IPluginInstallerSimple` if the installer can work directly with the archive. This is what - most installers use. - - `IPluginInstallerCustom` if the installer needs to perform custom operations. This is only - used by the external NCC installer and the OMOD installer. - """ - - @abc.abstractmethod - def isArchiveSupported(self, tree: "IFileTree") -> bool: - """ - Check if the given file tree corresponds to a supported archive for this installer. - - Args: - tree: The tree representing the content of the archive. - - Returns: - True if this installer can handle the archive, False otherwise. - """ - ... - @abc.abstractmethod - def isManualInstaller(self) -> bool: - """ - Check if this installer is a manual installer. - - Returns: - True if this installer is a manual installer, False otherwise. - """ - ... - @abc.abstractmethod - def priority(self) -> int: - """ - Retrieve the priority of this installer. - - If multiple installers are able to handle an archive, the one with the highest priority wins. - - Returns: - The priority of this installer. - """ - ... - def setInstallationManager(self, manager: "IInstallationManager"): - """ - Set the installation manager for this installer. - - Python plugins usually do not need to re-implement this and can directly access the installation - manager using `_manager()`. - - Args: - manager: The installation manager. - """ - ... - def setParentWidget(self, parent: PyQt5.QtWidgets.QWidget): - """ - Set the parent widget for this installer. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - - Args: - parent: The parent widget. - """ - ... - -class IPluginInstallerCustom(IPluginInstaller): - """ - Custom installer for mods. Custom installers receive the archive name and have to go - from there. They have to be able to extract the archive themself. - - Example of such installers are the external NCC installer or the OMOD installer. - """ - - def __init__(self): ... - def _manager(self) -> "IInstallationManager": - """ - Returns: - The installation manager. - """ - ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def install( - self, - mod_name: "GuessedString", - game_name: str, - archive_name: str, - version: str, - nexus_id: int, - ) -> "InstallResult": - """ - Install the given archive. - - The mod needs to be created by calling `IOrganizer.createMod` first. - - Args: - mod_name: Name of the mod to install. As an input parameter this is the suggested name - (e.g. from meta data) The installer may change this parameter to rename the mod). - game_name: Name of the game for which the mod is installed. - archive_name: Name of the archive to install. - version: Version of the mod. May be empty if the version is not yet known. The plugin is responsible - for setting the version on the created mod. - nexus_id: ID of the mod or -1 if unknown. The plugin is responsible for setting the mod ID for the - created mod. - - Returns: - The result of the installation process. - """ - ... - @overload - @abc.abstractmethod - def isArchiveSupported(self, tree: "IFileTree") -> bool: - """ - Check if the given file tree corresponds to a supported archive for this installer. - - Args: - tree: The tree representing the content of the archive. - - Returns: - True if this installer can handle the archive, False otherwise. - """ - ... - @overload - @abc.abstractmethod - def isArchiveSupported(self, archive_name: str) -> bool: - """ - Check if the given file is a supported archive for this installer. - - Args: - archive_name: Name of the archive. - - Returns: - True if this installer can handle the archive, False otherwise. - """ - ... - @abc.abstractmethod - def supportedExtensions(self) -> List[str]: - """ - Returns: - A list of file extensions that this installer can handle. - """ - ... - -class IPluginInstallerSimple(IPluginInstaller): - """ - Simple installer for mods. Simple installers only deal with an in-memory structure - representing the archive and can modify what to install and where by editing this structure. - Actually extracting the archive is handled by the manager. - """ - - def __init__(self): ... - def _manager(self) -> "IInstallationManager": - """ - Returns: - The installation manager. - """ - ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def install( - self, name: "GuessedString", tree: "IFileTree", version: str, nexus_id: int - ) -> Union[ - "InstallResult", "IFileTree", Tuple["InstallResult", "IFileTree", str, int] - ]: - """ - Install a mod from an archive filetree. - - The installer can modify the given tree and use the manager to extract or create new - files. - - This method returns different type of objects depending on the actual result of the - installation. The C++ bindings for this method always returns a tuple (result, tree, - version, id). - - Args: - name: Name of the mod to install. As an input parameter this is the suggested name - (e.g. from meta data) The installer may change this parameter to rename the mod). - tree: In-memory representation of the archive content. - version: Version of the mod, or an empty string is unknown. - nexus_id: ID of the mod, or -1 if unknown. - - Returns: - In case of failure, the result of the installation, otherwise the modified tree or - a tuple (result, tree, version, id) containing the result of the installation, the - modified tree, the new version and the new ID. The tuple can be returned even if the - installation did not succeed. - """ - ... - -class IPluginList: - """ - Primary interface to the list of plugins. - """ - - def isMaster(self, name: str) -> bool: - """ - Check if a plugin is a master file (basically a library, referenced by other plugins). - - In gamebryo games, a master file will usually have a .esm file extension but technically - an esp can be flagged as master and an esm might not be. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - True if the given plugin is a master plugin, False otherwise or if the file does not exist. - """ - ... - def loadOrder(self, name: str) -> int: - """ - Retrieve the load order of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The load order of the plugin (the order in which the game loads it). If all plugins are enabled this - is the same as the priority but disabled plugins will have a load order of -1. This also returns -1 - if the plugin does not exist. - """ - ... - def masters(self, name: str) -> List[str]: - """ - Retrieve the list of masters required for a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The list of masters for the plugin (filenames with extension, no path). - """ - ... - def onPluginMoved(self, callback: Callable[[str, int, int], None]) -> bool: - """ - Install a new handler to be called when a plugin is moved. - - Args: - callback: The function to call when a plugin is moved. The first parameter is the plugin name, the - second the old priority of the plugin and the third one the new priority. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onPluginStateChanged(self, callback: Callable[[str, int], None]) -> bool: - """ - Install a new handler to be called when a plugin state changes. - - Args: - callback: The function to call when a plugin state changes. The first parameter is the plugin name, the - second the new state of the plugin. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def onRefreshed(self, callback: Callable[[None], None]) -> bool: - """ - Install a new handler to be called when the list of plugins is refreshed. - - Args: - callback: The function to call when the list of plugins is refreshed. - - Returns: - True if the handler was installed properly (there are currently no reasons for this to fail). - """ - ... - def origin(self, name: str) -> str: - """ - Retrieve the origin of a plugin. This is either the (internal) name of a mod, `"overwrite"` or `"data"`. - - The internal name of a mod can differ from the display name for disambiguation. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The name of the origin of the plugin, or an empty string if the plugin does not exist. - """ - ... - def pluginNames(self) -> List[str]: - """ - Returns: - The list of all plugin names. - """ - ... - def priority(self, name: str) -> int: - """ - Retrieve the priority of a plugin. - - The higher the priority, the more important. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The priority of the given plugin, or -1 if the plugin does not exist. - """ - ... - def setLoadOrder(self, loadorder: List[str]): - """ - Set the load order. - - Plugins not included in the list will be placed at highest priority in the order they - were before. - - Args: - loadorder: The new load order, specified by the list of plugin names, sorted. - """ - ... - def setPriority(self, name: str, priority: int) -> bool: ... - def setState(self, name: str, state: int): - """ - Set the state of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - state: New state of the plugin (`INACTIVE` or `ACTIVE`). - """ - ... - def state(self, name: str) -> int: - """ - Retrieve the state of a plugin. - - Args: - name: Filename of the plugin (without path but with file extension). - - Returns: - The state of the plugin. - """ - ... - -class IPluginModPage(IPlugin): - def __init__(self): ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def displayName(self) -> str: - """ - Returns: - The name of the page as displayed in the UI. - """ - ... - @abc.abstractmethod - def handlesDownload( - self, - page_url: PyQt5.QtCore.QUrl, - download_url: PyQt5.QtCore.QUrl, - fileinfo: "ModRepositoryFileInfo", - ) -> bool: - """ - Check if the plugin handles the specified download. - - Args: - page_url: URL of the page that contains the download link. - download_url: The download URL. - fileinfo: Not usable in python. - - Returns: - True if this plugin wants to handle the specified download, False otherwise. - """ - ... - @abc.abstractmethod - def icon(self) -> PyQt5.QtGui.QIcon: - """ - Returns: - The icon to display with the page. - """ - ... - @abc.abstractmethod - def pageURL(self) -> PyQt5.QtCore.QUrl: - """ - Returns: - The URL to open when the user wants to visit this mod page. - """ - ... - def setParentWidget(self, parent: PyQt5.QtWidgets.QWidget): - """ - Set the parent widget for this mod page. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - - Args: - parent: The parent widget. - """ - ... - @abc.abstractmethod - def useIntegratedBrowser(self) -> bool: - """ - Indicates if the page should be displayed in the integrated browser. - - Unless the page provides a special means of starting downloads (like the nxm:// url schema - on nexus), it will not be possible to handle downloads unless the integrated browser is used! - - Returns: - True if the page should be opened in the integrated browser, False otherwise. - """ - ... - -class IPluginPreview(IPlugin): - """ - These plugins add support for previewing files in the data pane. Right now all image formats supported - by qt are implemented (including dds) but no audio files and no 3d mesh formats. - """ - - def __init__(self): ... - @abc.abstractmethod - def genFilePreview( - self, filename: str, max_size: PyQt5.QtCore.QSize - ) -> PyQt5.QtWidgets.QWidget: - """ - Generate a preview for the specified file. - - Args: - filename: Path to the file to preview. - max_size: Maximum size of the generated widget. - - Returns: - The widget showing a preview of the file. - """ - ... - @abc.abstractmethod - def supportedExtensions(self) -> List[str]: - """ - Returns: - The list of file extensions that are supported by this preview plugin. - """ - ... - -class IPluginTool(IPlugin): - """ - This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools submenu - and get invoked when the user clicks it. They are expected to have a user interface of some sort. These - are almost like independent applications except they can access all Mod Organizer interfaces like querying - and modifying the current profile, mod list, load order, use MO to install mods and so on. A tool plugin - can (and should!) integrate its UI as a window inside MO and thus doesn't have to initialize a windows - application itself. - """ - - def __init__(self): ... - def _parentWidget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The parent widget. - """ - ... - @abc.abstractmethod - def display(self): - """ - Called when the user starts the tool. - """ - ... - @abc.abstractmethod - def displayName(self) -> str: - """ - Returns: - The display name for this tool, as shown in the tool menu. - """ - ... - @abc.abstractmethod - def icon(self) -> PyQt5.QtGui.QIcon: - """ - Returns: - The icon for this tool, or a default-constructed QICon(). - """ - ... - def setParentWidget(self, parent: PyQt5.QtWidgets.QWidget): - """ - Set the parent widget for this tool. - - Python plugins usually do not need to re-implement this and can directly access the parent - widget using `_parentWidget()` once the UI has been initialized. - - Args: - parent: The parent widget. - """ - ... - @abc.abstractmethod - def tooltip(self) -> str: - """ - Returns: - The tooltip for this tool. - """ - ... - -class IProfile: - def absolutePath(self) -> str: ... - def invalidationActive(self) -> Tuple[bool, bool]: ... - def localSavesEnabled(self) -> bool: ... - def localSettingsEnabled(self) -> bool: ... - def name(self) -> str: ... - -class ISaveGame: - """ - Base class for information about what is in a save game. - """ - - def __init__(self): ... - def allFiles(self) -> List[str]: - """ - Returns: - The list of all files related to this save. - """ - ... - def getCreationTime(self) -> PyQt5.QtCore.QDateTime: - """ - Retrieve the creation time of the save. - - The creation time of a save is not always the same as the creation time of - the file containing the save. - - Returns: - The creation time of the save. - """ - ... - def getFilename(self) -> str: - """ - Returns: - The name of the (main) save file. - """ - ... - def getSaveGroupIdentifier(self) -> str: - """ - Retrieve the name of the group this files belong to. - - The name can be used to identify sets of saves to transfer between profiles. For - RPG games, this is usually the name of a character. - - Returns: - The group identifier for this save game. - """ - ... - def hasScriptExtenderFile(self) -> bool: - """ - Returns: - True if this save game has an associated script extender save, False otherwise. - """ - ... - -class ISaveGameInfoWidget(PyQt5.QtWidgets.QWidget): - """ - Base class for a save game info widget. - """ - - def __init__(self, parent: PyQt5.QtWidgets.QWidget = None): - """ - Args: - parent: Parent widget. - """ - ... - def _widget(self) -> PyQt5.QtWidgets.QWidget: - """ - Returns: - The underlying `QWidget`. - """ - ... - @abc.abstractmethod - def setSave(self, save: str): - """ - Set the save file to display in this widget. - - Args: - save: Path to the save file. - """ - ... - -class LocalSavegames(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def mappings(self, profile_save_dir: PyQt5.QtCore.QDir) -> List["Mapping"]: ... - @abc.abstractmethod - def prepareProfile(self, profile: "IProfile") -> bool: ... - -class Mapping: - @property - def createTarget(self) -> bool: ... - @createTarget.setter - def createTarget(self, arg0: bool): ... - @property - def destination(self) -> str: ... - @destination.setter - def destination(self, arg0: str): ... - @property - def isDirectory(self) -> bool: ... - @isDirectory.setter - def isDirectory(self, arg0: bool): ... - @property - def source(self) -> str: ... - @source.setter - def source(self, arg0: str): ... - def __init__(self): - """ - Creates an empty Mapping. - """ - ... - -class ModDataChecker(abc.ABC): - """ - Game feature that is used to check the content of a data tree. - """ - - class CheckReturn(Enum): - INVALID = ... - FIXABLE = ... - VALID = ... - def __and__(self, other: int) -> bool: ... - def __or__(self, other: int) -> bool: ... - def __rand__(self, other: int) -> bool: ... - def __ro__(self, other: int) -> bool: ... - FIXABLE: "ModDataChecker.CheckReturn" = ... - INVALID: "ModDataChecker.CheckReturn" = ... - VALID: "ModDataChecker.CheckReturn" = ... - def __init__(self): ... - @abc.abstractmethod - def dataLooksValid(self, filetree: "IFileTree") -> "ModDataChecker.CheckReturn": - """ - Check that the given filetree represent a valid mod layout, or can be easily - fixed. - - This method is mainly used during installation (to find which installer should - be used or to recurse into multi-level archives), or to quickly indicates to a - user if a mod looks valid. - - This method does not have to be exact, it only has to indicate if the given tree - looks like a valid mod or not by quickly checking the structure (heavy operations - should be avoided). - - If the tree can be fixed by the `fix()` method, this method should return `FIXABLE`. - `FIXABLE` should only be returned when it is guaranteed that `fix()` can fix the tree. - - Args: - filetree: The tree starting at the root of the "data" folder. - - Returns: - Whether the tree is invalid, fixable or valid. - """ - ... - def fix(self, filetree: "IFileTree") -> Optional["IFileTree"]: - """ - Try to fix the given tree. - - This method is used during installation to try to fix invalid archives and will only be - called if dataLooksValid returned `FIXABLE`. - - Args: - filetree: The tree to try to fix. Can be modified during the process. - - Returns: - The fixed tree, or a null pointer if the tree could not be fixed. - """ - ... - -class ModDataContent(abc.ABC): - """ - The ModDataContent feature is used (when available) to indicate to users the content - of mods in the "Content" column. - - The feature exposes a list of possible content types, each associated with an ID, a name - and an icon. The icon is the path to either: - - - A Qt resource or; - - A file on the disk. - - In order to facilitate the implementation, MO2 already provides a set of icons that can - be used. Those icons are all under ``:/MO/gui/content`` (e.g. ``:/MO/gui/content/plugin`` or ``:/MO/gui/content/music`` `). - - The list of available icons is: - - - ``plugin``: |plugin-icon| - - ``skyproc``: |skyproc-icon| - - ``texture``: |texture-icon| - - ``music``: |music-icon| - - ``sound``: |sound-icon| - - ``interface``: |interface-icon| - - ``skse``: |skse-icon| - - ``script``: |script-icon| - - ``mesh``: |mesh-icon| - - ``string``: |string-icon| - - ``bsa``: |bsa-icon| - - ``menu``: |menu-icon| - - ``inifile``: |inifile-icon| - - ``modgroup``: |modgroup-icon| - - .. |plugin-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/jigsaw-piece.png - .. |skyproc-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/hand-of-god.png - .. |texture-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/empty-chessboard.png - .. |music-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/double-quaver.png - .. |sound-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/lyre.png - .. |interface-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/usable.png - .. |skse-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/checkbox-tree.png - .. |script-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/tinker.png - .. |mesh-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/breastplate.png - .. |string-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/conversation.png - .. |bsa-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/locked-chest.png - .. |menu-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/config.png - .. |inifile-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/feather-and-scroll.png - .. |modgroup-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/xedit.png - """ - - class Content: - @property - def icon(self) -> str: ... - @property - def id(self) -> int: ... - @property - def name(self) -> str: ... - def __init__(self, id: int, name: str, icon: str, filter_only: bool = False): - """ - Args: - id: ID of this content. - name: Name of this content. - icon: Path to the icon for this content. Can be either a path - to an image on the disk, or to a resource. Can be an empty string if filterOnly - is true. - filter_only: Indicates if the content should only be show in the filter - criteria and not in the actual Content column. - """ - ... - def isOnlyForFilter(self) -> bool: - """ - Returns: - True if this content is only meant to be used as a filter criteria. - """ - ... - def __init__(self): ... - @abc.abstractmethod - def getAllContents(self) -> List["ModDataContent.Content"]: - """ - Returns: - The list of all possible contents for the corresponding game. - """ - ... - @abc.abstractmethod - def getContentsFor(self, filetree: "IFileTree") -> List[int]: - """ - Retrieve the list of contents in the given tree. - - Args: - filetree: The tree corresponding to the mod to retrieve contents for. - - Returns: - The IDs of the content in the given tree. - """ - ... - -class ModRepositoryFileInfo: - @property - def categoryID(self) -> int: ... - @categoryID.setter - def categoryID(self, arg0: int): ... - @property - def description(self) -> str: ... - @description.setter - def description(self, arg0: str): ... - @property - def fileCategory(self) -> int: ... - @fileCategory.setter - def fileCategory(self, arg0: int): ... - @property - def fileID(self) -> int: ... - @fileID.setter - def fileID(self, arg0: int): ... - @property - def fileName(self) -> str: ... - @fileName.setter - def fileName(self, arg0: str): ... - @property - def fileSize(self) -> int: ... - @fileSize.setter - def fileSize(self, arg0: int): ... - @property - def fileTime(self) -> PyQt5.QtCore.QDateTime: ... - @fileTime.setter - def fileTime(self, arg0: PyQt5.QtCore.QDateTime): ... - @property - def gameName(self) -> str: ... - @gameName.setter - def gameName(self, arg0: str): ... - @property - def modID(self) -> int: ... - @modID.setter - def modID(self, arg0: int): ... - @property - def modName(self) -> str: ... - @modName.setter - def modName(self, arg0: str): ... - @property - def name(self) -> str: ... - @name.setter - def name(self, arg0: str): ... - @property - def newestVersion(self) -> "VersionInfo": ... - @newestVersion.setter - def newestVersion(self, arg0: "VersionInfo"): ... - @property - def repository(self) -> str: ... - @repository.setter - def repository(self, arg0: str): ... - @property - def uri(self) -> str: ... - @uri.setter - def uri(self, arg0: str): ... - @property - def userData(self) -> MoVariant: ... - @userData.setter - def userData(self, arg0: MoVariant): ... - @property - def version(self) -> "VersionInfo": ... - @version.setter - def version(self, arg0: "VersionInfo"): ... - @overload - def __init__(self, other: "ModRepositoryFileInfo"): ... - @overload - def __init__( - self, game_name: str = None, mod_id: int = None, file_id: int = None - ): ... - def __str__(self) -> str: ... - @staticmethod - def createFromJson(data: str) -> "ModRepositoryFileInfo": ... - -class PluginSetting: - """ - Class to hold the user-configurable parameters a plugin accepts. The purpose of this class is - only to inform the application what settings to offer to the user, it does not hold the actual value. - """ - - @property - def default_value(self) -> MoVariant: ... - @default_value.setter - def default_value(self, arg0: MoVariant): ... - @property - def description(self) -> str: ... - @description.setter - def description(self, arg0: str): ... - @property - def key(self) -> str: ... - @key.setter - def key(self, arg0: str): ... - def __init__(self, key: str, description: str, default_value: MoVariant): - """ - Args: - key: Name of the setting. - description: Description of the setting. - default_value: Default value of the setting. - """ - ... - -class SaveGameInfo(abc.ABC): - """ - Feature to get hold of stuff to do with save games. - """ - - def __init__(self): ... - @abc.abstractmethod - def getMissingAssets(self, filepath: str) -> Dict[str, List[str]]: - """ - Retrieve missing assets from the save. - - Args: - filepath: Path to the save file. - - Returns: - A collection of missing assets and the modules that can supply those assets. - """ - ... - @abc.abstractmethod - def getSaveGameInfo(self, filepath: str) -> "ISaveGame": - """ - Retrieve the information about the supplied save game. - - Args: - filepath: Path to the save file. - - Returns: - A SaveGame corresponding to the given save file. - """ - ... - @abc.abstractmethod - def getSaveGameWidget( - self, parent: PyQt5.QtWidgets.QWidget - ) -> Optional["ISaveGameInfoWidget"]: - """ - Retrieve a widget to display over the save game list. - - This method is allowed to return `None` in case no widget has been implemented. - - Args: - parent: The parent widget. - - Returns: - A SaveGameInfoWidget to display information about save game. - """ - ... - @abc.abstractmethod - def hasScriptExtenderSave(self, filepath: str) -> bool: - """ - Check whether or not the save has a paired script extender save. - - Args: - filepath: Path to the save file. - - Returns: - True if the given save file has a paired script extender save, False otherwise. - """ - ... - -class ScriptExtender(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def BinaryName(self) -> str: - """ - Returns: - The name of the script extender binary. - """ - ... - @abc.abstractmethod - def PluginPath(self) -> str: - """ - Returns: - The script extender plugin path, relative to the data folder. - """ - ... - @abc.abstractmethod - def getArch(self) -> int: - """ - Returns: - The CPU platform of the extender. - """ - ... - @abc.abstractmethod - def getExtenderVersion(self) -> str: - """ - Returns: - The version of the script extender. - """ - ... - @abc.abstractmethod - def isInstalled(self) -> bool: - """ - Returns: - True if the script extender is installed, False otherwise. - """ - ... - @abc.abstractmethod - def loaderName(self) -> str: - """ - Returns: - The loader to use to ensure the game runs with the script extender. - """ - ... - @abc.abstractmethod - def loaderPath(self) -> str: - """ - Returns: - The fullpath to the script extender loader. - """ - ... - @abc.abstractmethod - def saveGameAttachmentExtensions(self) -> List[str]: - """ - Returns: - Additional savegame attachments. - """ - ... - -class UnmanagedMods(abc.ABC): - def __init__(self): ... - @abc.abstractmethod - def displayName(self, mod_name: str) -> str: - """ - Retrieve the display name of a given mod. - - Args: - mod_name: Internal name of the mod. - - Returns: - The display name of the mod. - """ - ... - @abc.abstractmethod - def mods(self, official_only: bool) -> List[str]: - """ - Retrieve the list of unmanaged mods for the corresponding game. - - Args: - official_only: Retrieve only unmanaged official mods. - - Returns: - The list of unmanaged mods (internal names). - """ - ... - @abc.abstractmethod - def referenceFile(self, mod_name: str) -> PyQt5.QtCore.QFileInfo: - """ - Retrieve the reference file for the requested mod. - - Example: For Bethesda games, the reference file may be the main - plugin (esp or esm) for the game or a DLCs. - - Args: - mod_name: Internal name of the mod. - - Returns: - The reference file (absolute path) for the requested mod. - """ - ... - @abc.abstractmethod - def secondaryFiles(self, mod_name: str) -> List[str]: - """ - Retrieve the secondary files for the requested mod. - - Example: For Bethesda games, the secondary files may be the archives - corresponding to the reference file. - - Args: - mod_name: Internal name of the mod. - - Returns: - The secondary files (absolute paths) for the request mod. - """ - ... - -class VersionInfo: - """ - Represents the version of a mod or plugin. - """ - - @overload - def __init__(self): - """ - Construct an invalid VersionInfo. - """ - ... - @overload - def __init__(self, value: str, scheme: "VersionScheme" = VersionScheme.DISCOVER): - """ - Construct a VersionInfo by parsing the given string according to the given scheme. - - Args: - value: String to parse. - scheme: Scheme to use to parse the string. - """ - ... - @overload - def __init__( - self, - major: int, - minor: int, - subminor: int, - subsubminor: int, - release_type: "ReleaseType" = ReleaseType.FINAL, - ): - """ - Construct a VersionInfo using the given elements. - - Args: - major: Major version. - minor: Minor version. - subminor: Subminor version. - subsubminor: Subsubminor version. - release_type: Type of release. - """ - ... - @overload - def __init__( - self, - major: int, - minor: int, - subminor: int, - release_type: "ReleaseType" = ReleaseType.FINAL, - ): - """ - Construct a VersionInfo using the given elements. - - Args: - major: Major version. - minor: Minor version. - subminor: Subminor version. - release_type: Type of release. - """ - ... - @overload - def __eq__(self, arg2: "VersionInfo") -> bool: ... - @overload - def __eq__(self, other: object) -> bool: ... - def __ge__(self, arg2: "VersionInfo") -> bool: ... - def __gt__(self, arg2: "VersionInfo") -> bool: ... - def __le__(self, arg2: "VersionInfo") -> bool: ... - def __lt__(self, arg2: "VersionInfo") -> bool: ... - @overload - def __ne__(self, arg2: "VersionInfo") -> bool: ... - @overload - def __ne__(self, other: object) -> bool: ... - def __str__(self) -> str: - """ - Returns: - See `canonicalString()`. - """ - ... - def canonicalString(self) -> str: - """ - Returns: - A canonical string representing this version, that can be stored and then parsed using the parse() method. - """ - ... - def clear(self): - """ - Resets this VersionInfo to an invalid version. - """ - ... - def displayString(self, forced_segments: int = 2) -> str: - """ - Args: - forced_segments: The number of version segments to display even if the version is 0. 1 is major, 2 is major - and minor, etc. The only implemented ranges are (-inf,2] for major/minor, [3] for major/minor/subminor, - and [4,inf) for major/minor/subminor/subsubminor. This only versions with a regular scheme. - - Returns: - A string for display to the user. The returned string may not contain enough information to reconstruct this version info. - """ - ... - def isValid(self) -> bool: - """ - Returns: - True if this VersionInfo is valid, False otherwise. - """ - ... - def parse( - self, - value: str, - scheme: "VersionScheme" = VersionScheme.DISCOVER, - manual_input: bool = False, - ): - """ - Update this VersionInfo by parsing the given string using the given scheme. - - Args: - value: String to parse. - scheme: Scheme to use to parse the string. - manual_input: True if the given string should be treated as user input. - """ - ... - def scheme(self) -> "VersionScheme": - """ - Returns: - The version scheme in effect for this VersionInfo. - """ - ... diff --git a/stubs/setup/setup.py b/stubs/setup/setup.py deleted file mode 100644 index f9471f2..0000000 --- a/stubs/setup/setup.py +++ /dev/null @@ -1,57 +0,0 @@ -"""Python setup script. - -:author: Stefan Lehmann -:license: MIT, see license file or https://opensource.org/licenses/MIT - -:created on 2018-10-06 10:55:36 -:last modified by: Stefan Lehmann -:last modified time: 2019-07-23 10:27:04 - -""" -import io -import os -import re -from setuptools import setup - - -def read(*names, **kwargs): - try: - with io.open( - os.path.join(os.path.dirname(__file__), *names), - encoding=kwargs.get("encoding", "utf8"), - ) as fp: - return fp.read() - except IOError: - return "" - - -def find_version(*file_paths): - version_file = read(*file_paths) - version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M) - if version_match: - return version_match.group(1) - raise RuntimeError("Unable to find version string.") - - -long_description = read("README.md") - - -setup( - name="mobase-stubs", - url="https://github.com/ModOrganizer2/mo2-pystubs-generation", - author="Holt59", - description="PEP561 stub files for the mobase python API", - long_description=long_description, - long_description_content_type="text/markdown", - version=find_version("mobase-stubs", "__init__.pyi"), - package_data={"mobase-stubs": ["*.pyi"]}, - packages=["mobase-stubs"], - install_requires=["PyQt5-stubs==5.14.2"], - python_requires="==3.8.*", - classifiers=[ - "Intended Audience :: Developers", - "Programming Language :: Python :: 3.8", - "License :: OSI Approved :: MIT License", - "Topic :: Software Development", - ], -)