rez.status

class rez.status.Status

Bases: object

Access to current status of the environment.

The current status tells you things such as if you are within a context, or if suite(s) are visible on $PATH.

active_suite_context_name

Simple property caching descriptor.

Example

>>> class Foo(object):
>>>     @cached_property
>>>     def bah(self):
>>>         print('bah')
>>>         return 1
>>>
>>> f = Foo()
>>> f.bah
bah
1
>>> f.bah
1

context

Simple property caching descriptor.

Example

>>> class Foo(object):
>>>     @cached_property
>>>     def bah(self):
>>>         print('bah')
>>>         return 1
>>>
>>> f = Foo()
>>> f.bah
bah
1
>>> f.bah
1

context_file

Simple property caching descriptor.

Example

>>> class Foo(object):
>>>     @cached_property
>>>     def bah(self):
>>>         print('bah')
>>>         return 1
>>>
>>> f = Foo()
>>> f.bah
bah
1
>>> f.bah
1

parent_suite

Simple property caching descriptor.

Example

>>> class Foo(object):
>>>     @cached_property
>>>     def bah(self):
>>>         print('bah')
>>>         return 1
>>>
>>> f = Foo()
>>> f.bah
bah
1
>>> f.bah
1

print_info(obj=None, buf=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Print a status message about the given object.

If an object is not provided, status info is shown about the current environment - what the active context is if any, and what suites are visible.

Parameters

obj (str) – String which may be one of the following: - A tool name; - A package name, possibly versioned; - A context filepath; - A suite filepath; - The name of a context in a visible suite.

print_tools(pattern=None, buf=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'>)

Print a list of visible tools.

Parameters

pattern (str) – Only list tools that match this glob pattern.

suites

Simple property caching descriptor.

Example

>>> class Foo(object):
>>>     @cached_property
>>>     def bah(self):
>>>         print('bah')
>>>         return 1
>>>
>>> f = Foo()
>>> f.bah
bah
1
>>> f.bah
1