| | |
- builtins.tuple(builtins.object)
-
- EnvTemplate
- rcmpy.environment.base.BaseEnvironment(vcorelib.logging.LoggerMixin)
-
- TemplateEnvironment
class EnvTemplate(builtins.tuple) |
| |
EnvTemplate(name: str, path: pathlib.Path, subdir: str, template: Optional[jinja2.environment.Template] = None)
A data structure for keeping track of environment templates. If 'template'
is None, it signals that the template does not require rendering.
|
| |
- Method resolution order:
- EnvTemplate
- builtins.tuple
- builtins.object
Methods defined here:
- __getnewargs__(self)
- Return self as a plain tuple. Used by copy and pickle.
- __repr__(self)
- Return a nicely formatted representation string
- _asdict(self)
- Return a new dict which maps field names to their values.
- _replace(self, /, **kwds)
- Return a new EnvTemplate object replacing specified fields with new values
Class methods defined here:
- _make(iterable) from builtins.type
- Make a new EnvTemplate object from a sequence or iterable
Static methods defined here:
- __new__(_cls, name: str, path: pathlib.Path, subdir: str, template: Optional[jinja2.environment.Template] = None)
- Create new instance of EnvTemplate(name, path, subdir, template)
Data descriptors defined here:
- name
- Alias for field number 0
- path
- Alias for field number 1
- subdir
- Alias for field number 2
- template
- Alias for field number 3
Data and other attributes defined here:
- __annotations__ = {'name': <class 'str'>, 'path': <class 'pathlib.Path'>, 'subdir': <class 'str'>, 'template': typing.Optional[jinja2.environment.Template]}
- __match_args__ = ('name', 'path', 'subdir', 'template')
- __orig_bases__ = (<function NamedTuple>,)
- _field_defaults = {'template': None}
- _fields = ('name', 'path', 'subdir', 'template')
Methods inherited from builtins.tuple:
- __add__(self, value, /)
- Return self+value.
- __contains__(self, key, /)
- Return bool(key in self).
- __eq__(self, value, /)
- Return self==value.
- __ge__(self, value, /)
- Return self>=value.
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __getitem__(self, key, /)
- Return self[key].
- __gt__(self, value, /)
- Return self>value.
- __hash__(self, /)
- Return hash(self).
- __iter__(self, /)
- Implement iter(self).
- __le__(self, value, /)
- Return self<=value.
- __len__(self, /)
- Return len(self).
- __lt__(self, value, /)
- Return self<value.
- __mul__(self, value, /)
- Return self*value.
- __ne__(self, value, /)
- Return self!=value.
- __rmul__(self, value, /)
- Return value*self.
- count(self, value, /)
- Return number of occurrences of value.
- index(self, value, start=0, stop=9223372036854775807, /)
- Return first index of value.
Raises ValueError if the value is not present.
Class methods inherited from builtins.tuple:
- __class_getitem__(...) from builtins.type
- See PEP 585
|
class TemplateEnvironment(rcmpy.environment.base.BaseEnvironment) |
| |
TemplateEnvironment(state: rcmpy.state.State, stack: contextlib.ExitStack) -> None
A class implementing template management for this package's runtime
environment.
|
| |
- Method resolution order:
- TemplateEnvironment
- rcmpy.environment.base.BaseEnvironment
- vcorelib.logging.LoggerMixin
- builtins.object
Methods defined here:
- is_updated(self, file: rcmpy.config.file.ManagedFile) -> bool
- Determine if a managed file is updated or not (based on template
changes).
Data and other attributes defined here:
- __annotations__ = {'jinja': <class 'jinja2.environment.Environment'>, 'templates': typing.Dict[pathlib.Path, rcmpy.environment.template.EnvTemplate], 'templates_by_name': typing.Dict[str, rcmpy.environment.template.EnvTemplate]}
Methods inherited from rcmpy.environment.base.BaseEnvironment:
- __init__(self, state: rcmpy.state.State, stack: contextlib.ExitStack) -> None
- Initialize this instance.
Readonly properties inherited from rcmpy.environment.base.BaseEnvironment:
- config
- Get this environment's configuration object.
- config_loaded
- Determine if this environment has loaded a config.
Methods inherited from vcorelib.logging.LoggerMixin:
- log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]
- A simple wrapper.
Data descriptors inherited from vcorelib.logging.LoggerMixin:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
| |