aiida.orm.utils.builders package¶
Submodules¶
Manage code objects with lazy loading of the db env
-
class
aiida.orm.utils.builders.code.
CodeBuilder
(**kwargs)[source]¶ Bases:
object
Build a code with validation of attribute combinations
-
class
CodeType
[source]¶ Bases:
enum.Enum
An enumeration.
-
ON_COMPUTER
= 'on computer'¶
-
STORE_AND_UPLOAD
= 'store in the db and upload'¶
-
__module__
= 'aiida.orm.utils.builders.code'¶
-
-
exception
CodeValidationError
(msg)[source]¶ Bases:
Exception
A CodeBuilder instance may raise this
when asked to instanciate a code with missing or invalid code attributes
when asked for a code attibute that has not been set yet
-
__module__
= 'aiida.orm.utils.builders.code'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
__dict__
= mappingproxy({'__module__': 'aiida.orm.utils.builders.code', '__doc__': 'Build a code with validation of attribute combinations', '__init__': <function CodeBuilder.__init__>, 'validate': <function CodeBuilder.validate>, 'new': <FunctionWrapper at 0x7fef22e59ee8 for function>, 'from_code': <staticmethod object>, 'get_code_spec': <staticmethod object>, '__getattr__': <function CodeBuilder.__getattr__>, '_get': <function CodeBuilder._get>, '_get_and_count': <function CodeBuilder._get_and_count>, '__setattr__': <function CodeBuilder.__setattr__>, '_set_code_attr': <function CodeBuilder._set_code_attr>, 'validate_code_type': <function CodeBuilder.validate_code_type>, 'validate_upload': <function CodeBuilder.validate_upload>, 'validate_installed': <function CodeBuilder.validate_installed>, 'CodeValidationError': <class 'aiida.orm.utils.builders.code.CodeBuilder.CodeValidationError'>, 'is_local': <function CodeBuilder.is_local>, 'CodeType': <enum 'CodeType'>, '__dict__': <attribute '__dict__' of 'CodeBuilder' objects>, '__weakref__': <attribute '__weakref__' of 'CodeBuilder' objects>})¶
-
__module__
= 'aiida.orm.utils.builders.code'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
_get_and_count
(key, used)[source]¶ Return a spec, or raise if not defined. Moreover, add the key to the ‘used’ dict.
- Parameters
key – name of a code spec
used – should be a set of keys that you want to track.
key
will be added to this set if the value exists in the spec and can be retrieved.
-
_set_code_attr
(key, value)[source]¶ Set a code attribute, if it passes validation.
Checks compatibility with other code attributes.
-
static
from_code
(code)[source]¶ Create CodeBuilder from existing code instance.
See also
get_code_spec()
-
class
Manage computer objects with lazy loading of the db env
-
class
aiida.orm.utils.builders.computer.
ComputerBuilder
(**kwargs)[source]¶ Bases:
object
Build a computer with validation of attribute combinations
-
exception
ComputerValidationError
(msg)[source]¶ Bases:
Exception
A ComputerBuilder instance may raise this
when asked to instanciate a code with missing or invalid computer attributes
when asked for a computer attibute that has not been set yet.
-
__module__
= 'aiida.orm.utils.builders.computer'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
__dict__
= mappingproxy({'__module__': 'aiida.orm.utils.builders.computer', '__doc__': 'Build a computer with validation of attribute combinations', 'from_computer': <staticmethod object>, 'get_computer_spec': <staticmethod object>, '__init__': <function ComputerBuilder.__init__>, 'validate': <function ComputerBuilder.validate>, 'new': <FunctionWrapper at 0x7fef25917250 for function>, '__getattr__': <function ComputerBuilder.__getattr__>, '_get': <function ComputerBuilder._get>, '_get_and_count': <function ComputerBuilder._get_and_count>, '__setattr__': <function ComputerBuilder.__setattr__>, '_set_computer_attr': <function ComputerBuilder._set_computer_attr>, 'ComputerValidationError': <class 'aiida.orm.utils.builders.computer.ComputerBuilder.ComputerValidationError'>, '__dict__': <attribute '__dict__' of 'ComputerBuilder' objects>, '__weakref__': <attribute '__weakref__' of 'ComputerBuilder' objects>})¶
-
__module__
= 'aiida.orm.utils.builders.computer'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
_get_and_count
(key, used)[source]¶ Return a spec, or raise if not defined. Moreover, add the key to the ‘used’ dict.
- Parameters
key – name of a computer spec
used – should be a set of keys that you want to track.
key
will be added to this set if the value exists in the spec and can be retrieved.
-
static
from_computer
(computer)[source]¶ Create ComputerBuilder from existing computer instance.
See also
get_computer_spec()
-
exception