2016-08-15 20:51:24 +01:00
|
|
|
*************
|
|
|
|
|
API Reference
|
|
|
|
|
*************
|
|
|
|
|
|
2019-10-22 21:02:15 +01:00
|
|
|
As this API is just a wrapper for libloot's C++ API, its documentation is linked
|
|
|
|
|
to for all non-Python-specific information.
|
2016-08-15 20:51:24 +01:00
|
|
|
|
2020-01-04 14:59:13 +00:00
|
|
|
The wrapped enumeration types are classes in Python, but the distinction
|
2016-08-19 19:46:19 +01:00
|
|
|
makes no difference in practice, so they're grouped here for semantics. All
|
2020-01-04 14:59:13 +00:00
|
|
|
their values are unsigned integer constants.
|
2016-08-16 08:12:50 +01:00
|
|
|
|
2020-01-04 14:59:13 +00:00
|
|
|
.. automodule:: loot
|
|
|
|
|
:members:
|
|
|
|
|
:exclude-members: Version, WrapperVersion
|
2016-08-19 19:46:19 +01:00
|
|
|
|
2019-10-22 21:02:15 +01:00
|
|
|
.. py:class:: loot.Version
|
2016-08-19 19:46:19 +01:00
|
|
|
|
|
|
|
|
Wraps :cpp:class:`loot::LootVersion`.
|
|
|
|
|
|
|
|
|
|
.. py:attribute:: major
|
|
|
|
|
|
|
|
|
|
An unsigned integer giving the major version number.
|
|
|
|
|
|
|
|
|
|
.. py:attribute:: minor
|
|
|
|
|
|
|
|
|
|
An unsigned integer giving the minor version number.
|
|
|
|
|
|
|
|
|
|
.. py:attribute:: patch
|
|
|
|
|
|
|
|
|
|
An unsigned integer giving the patch version number.
|
|
|
|
|
|
|
|
|
|
.. py:attribute:: revision
|
|
|
|
|
|
|
|
|
|
A Unicode string containing the SHA-1 of the Git revision that the wrapped C++ API was built from.
|
|
|
|
|
|
2020-01-04 14:59:13 +00:00
|
|
|
.. py:staticmethod:: string() -> str
|
2016-08-19 19:46:19 +01:00
|
|
|
|
|
|
|
|
Returns the API version as a string of the form ``major.minor.patch``
|
2016-09-18 17:43:04 +01:00
|
|
|
|
2019-10-22 21:02:15 +01:00
|
|
|
.. py:class:: loot.WrapperVersion
|
2016-09-18 17:43:04 +01:00
|
|
|
|
2019-10-22 21:02:15 +01:00
|
|
|
Provides information about the version of libloot-python that is being run.
|
2016-09-18 17:43:04 +01:00
|
|
|
|
|
|
|
|
.. py:attribute:: major
|
|
|
|
|
|
|
|
|
|
An unsigned integer giving the major version number.
|
|
|
|
|
|
|
|
|
|
.. py:attribute:: minor
|
|
|
|
|
|
|
|
|
|
An unsigned integer giving the minor version number.
|
|
|
|
|
|
|
|
|
|
.. py:attribute:: patch
|
|
|
|
|
|
|
|
|
|
An unsigned integer giving the patch version number.
|
|
|
|
|
|
|
|
|
|
.. py:attribute:: revision
|
|
|
|
|
|
|
|
|
|
A Unicode string containing the SHA-1 of the Git revision that the wrapped C++ API was built from.
|
|
|
|
|
|
2020-01-04 14:59:13 +00:00
|
|
|
.. py:staticmethod:: string() -> str
|
2016-09-18 17:43:04 +01:00
|
|
|
|
|
|
|
|
Returns the API version as a string of the form ``major.minor.patch``
|
