version — Determine Pywikibot Version#

Module to determine the pywikibot version (tag, revision and date).

version.get_module_filename(module)[source]#

Retrieve filename from an imported pywikibot module.

It uses the __file__ attribute of the module. If it’s file extension ends with py and another character the last character is discarded when the py file exist.

Parameters:

module (module) – The module instance.

Returns:

The filename if it’s a pywikibot module otherwise None.

Return type:

str | None

version.get_module_mtime(module)[source]#

Retrieve the modification time from an imported module.

Parameters:

module (module) – The module instance.

Returns:

The modification time if it’s a pywikibot module otherwise None.

Return type:

datetime or None

version.get_toolforge_hostname()[source]#

Get hostname of the current Toolforge host.

Added in version 3.0.

Deprecated since version 9.0.

Returns:

The hostname of the currently running host, if it is in Wikimedia Toolforge; otherwise return None.

Return type:

str | None

version.getversion(online=True)[source]#

Return a pywikibot version string.

Parameters:

online (bool) – Include information obtained online

Return type:

str

version.getversion_git(path=None)[source]#

Get version info for a Git clone.

Parameters:

path – directory of the Git checkout

Returns:

  • tag (name for the repository),

  • rev (current revision identifier),

  • date (date of current revision),

  • hash (git hash for the current revision)

Return type:

tuple of three str and a time.struct_time

version.getversion_nightly(path=None)[source]#

Get version info for a nightly release.

Hint

the version information of the nightly dump is stored in the version file within the pywikibot folder.

Parameters:

path (str | Path | None) – directory of the uncompressed nightly.

Returns:

  • tag (name for the repository),

  • rev (current revision identifier),

  • date (date of current revision),

  • hash (git hash for the current revision)

Return type:

tuple of three str and a time.struct_time

version.getversion_onlinerepo(path='branches/master')[source]#

Retrieve current framework git hash from Gerrit.

Parameters:

path (str)

Return type:

str

version.getversion_package(path=None)[source]#

Get version info for an installed package.

Parameters:

path – Unused argument

Returns:

  • tag: ‘pywikibot/__init__.py’

  • rev: ‘-1 (unknown)’

  • date (date the package was installed locally),

  • hash (git hash for the current revision of ‘pywikibot/__init__.py’)

Return type:

tuple[str, str, str, str]

version.getversiondict()[source]#

Get version info for the package.

Returns:

  • tag (name for the repository),

  • rev (current revision identifier),

  • date (date of current revision),

  • hash (git hash for the current revision)

Return type:

dict[str, str]

version.package_versions(modules=None, builtins=False, standard_lib=None)[source]#

Retrieve package version information.

When builtins or standard_lib are None, they will be included only if a version was found in the package.

Parameters:

  • modules (list[str] | None) – Modules to inspect

  • builtins (bool | None) – Include builtins

  • standard_lib (bool | None) – Include standard library packages