sphinx_reports.Common
Common exceptions, classes and helper functions.
Functions
ReadResourceFile(): Undocumented.
Exceptions
ReportExtensionError: Extension error.
Classes
LegendPosition: Support for flags
Functions
- sphinx_reports.Common.ReadResourceFile(module, filename)[source]
- Return type:
- Parameters:
module (str | ModuleType)
filename (str)
Exceptions
- exception sphinx_reports.Common.ReportExtensionError(message, orig_exc=None, modname=None)[source]
Inheritance
Classes
- class sphinx_reports.Common.LegendPosition(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Inheritance
- static _generate_next_value_(name, start, count, last_values)
Generate the next value when not given.
name: the name of the member start: the initial start value or None count: the number of existing members last_values: the last value assigned or None
- _numeric_repr_()
Return the canonical string representation of the object.
For many object types, including most builtins, eval(repr(obj)) == obj.
- classmethod _iter_member_by_value_(value)
Extract all members from the value in definition (i.e. increasing value) order.
- classmethod _iter_member_(value)
Extract all members from the value in definition (i.e. increasing value) order.
- classmethod _iter_member_by_def_(value)
Extract all members from the value in definition order.
- classmethod _missing_(value)
Create a composite member containing all canonical members present in value.
If non-member values are present, result depends on _boundary_ setting.
- __contains__(other)
Returns True if self has at least the same flags set as other.
- __iter__()
Returns flags in definition order.
- __len__()
Return the number of members (no aliases)
- __repr__()
Return repr(self).
- __str__()
Return str(self).
- __bool__()
classes/types should always be True.
- __or__(other)
Return self|value.
- __ror__(other)
Return value|self.
- __new__(value)