locator

Bindings for basic::resource_manager::locator namespace

class pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocator

Bases: pyrosetta.rosetta.basic.resource_manager.ResourceLocator

The %DatabaseResourceLocator class is responsible for retreiving data from a Database so that that data can then be used to construct a Resource.

Upon construction or in its parse_my_tag method, the

%DatabaseResourceLocator needs to be given the name of the database-session resource that it will use to communicate with the database and a partially formatted SQL command (a SELECT statement) that will be used to query the database for the resource that it will be pulling from the database. This SQL command should have a single question mark (“?”) for the variable that will be replaced by the locator_id that will be given to the %DatabaseResourceLocator when its locate_resource_stream method is invoked. In that method, the %DatabaseResourceLocator will ask the ResourceManager for the database session object and then bind the input “locator_id” to the previously provided SQL command, and finally will query the database with that statement. The resulting output is packaged in a string stream and returned to the code that called locate_resource_stream (e.g. the ResourceManager) and then can be used to construct a resource.

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocator) -> None
2. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocator, database_session_resource_tag: str, sql_command: str) -> None
3. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocator, arg0: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocator) -> None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocator, : pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocator) → pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocator

C++: basic::resource_manager::locator::DatabaseResourceLocator::operator=(const class basic::resource_manager::locator::DatabaseResourceLocator &) –> class basic::resource_manager::locator::DatabaseResourceLocator &

locate_resource_stream(self: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocator, locator_tag: str) → pyrosetta.rosetta.basic.resource_manager.ResourceStream

Create a ResourceStream object from the given resource

source, so that its stream can be passed to the ResourceLoader using the input “locator_tag” which is bound to the partially formed SQL select statement that was provided at construction or in parse_my_tag

C++: basic::resource_manager::locator::DatabaseResourceLocator::locate_resource_stream(const class std::basic_string<char> &) const –> class std::shared_ptr<class basic::resource_manager::ResourceStream>

locator_tag(*args, **kwargs)

Overloaded function.

1. locator_tag(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator, locator_tag: str) -> None

Set the name for this %ResourceLocator

C++: basic::resource_manager::ResourceLocator::locator_tag(const class std::basic_string<char> &) –> void

2. locator_tag(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator) -> str

Return the name for this %ResourceLocator

C++: basic::resource_manager::ResourceLocator::locator_tag() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocator, tag: utility::tag::Tag) → None

Initialize the %DatabaseResourceLoader from the input set of tags

which should contain both the name of the database session resource that will be used to talk to the database, and the partially formed SQL select statement that will be used to query the database.

C++: basic::resource_manager::locator::DatabaseResourceLocator::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>) –> void

show(self: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocator, out: pyrosetta.rosetta.std.ostream) → None

Describe the %DatabaseResourceLocator instance to the given output stream

C++: basic::resource_manager::locator::DatabaseResourceLocator::show(class std::basic_ostream<char> &) const –> void

type(self: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocator) → str

Return the typename for this class: “DatabaseResourceLocator”

C++: basic::resource_manager::locator::DatabaseResourceLocator::type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocatorCreator

Bases: pyrosetta.rosetta.basic.resource_manager.ResourceLocatorCreator

creator for the DatabaseResourceLocator class

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(self: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocatorCreator) → None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocatorCreator, : pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocatorCreator) → pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocatorCreator

C++: basic::resource_manager::locator::DatabaseResourceLocatorCreator::operator=(const class basic::resource_manager::locator::DatabaseResourceLocatorCreator &) –> class basic::resource_manager::locator::DatabaseResourceLocatorCreator &

create_resource_locator(self: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocatorCreator) → pyrosetta.rosetta.basic.resource_manager.ResourceLocator

C++: basic::resource_manager::locator::DatabaseResourceLocatorCreator::create_resource_locator() const –> class std::shared_ptr<class basic::resource_manager::ResourceLocator>

locator_type(self: pyrosetta.rosetta.basic.resource_manager.locator.DatabaseResourceLocatorCreator) → str

C++: basic::resource_manager::locator::DatabaseResourceLocatorCreator::locator_type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator

Bases: pyrosetta.rosetta.basic.resource_manager.ResourceLocator

The %FileListResourceLocator concatenates a set of listed files; e.g. useful for constructing a pose from two separate PDB files.

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator) -> None
2. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator, arg0: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator) -> None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator, : pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator) → pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator

C++: basic::resource_manager::locator::FileListResourceLocator::operator=(const class basic::resource_manager::locator::FileListResourceLocator &) –> class basic::resource_manager::locator::FileListResourceLocator &

get_open_mode(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator) → pyrosetta.rosetta.std._Ios_Openmode

C++: basic::resource_manager::locator::FileListResourceLocator::get_open_mode() const –> enum std::_Ios_Openmode

locate_resource_stream(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator, locator_tag: str) → pyrosetta.rosetta.basic.resource_manager.ResourceStream

Take the input locator tag and split it by whitespace, interpret each substring

as the name of a file, and concatenate each file into a single stringstream to be returned.

C++: basic::resource_manager::locator::FileListResourceLocator::locate_resource_stream(const class std::basic_string<char> &) const –> class std::shared_ptr<class basic::resource_manager::ResourceStream>

locator_tag(*args, **kwargs)

Overloaded function.

1. locator_tag(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator, locator_tag: str) -> None

Set the name for this %ResourceLocator

C++: basic::resource_manager::ResourceLocator::locator_tag(const class std::basic_string<char> &) –> void

2. locator_tag(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator) -> str

Return the name for this %ResourceLocator

C++: basic::resource_manager::ResourceLocator::locator_tag() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator, tag: utility::tag::Tag) → None

Do nothing, since there is no data that the %FileListResourceLocator needs.

C++: basic::resource_manager::locator::FileListResourceLocator::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>) –> void

set_open_mode(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator, open_mode: pyrosetta.rosetta.std._Ios_Openmode) → None

C++: basic::resource_manager::locator::FileListResourceLocator::set_open_mode(enum std::_Ios_Openmode) –> void

show(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator, out: pyrosetta.rosetta.std.ostream) → None

Describe the %FileListResourceLocator to the output stringstream; since

this class has no data, merely prints the name of the class.

C++: basic::resource_manager::locator::FileListResourceLocator::show(class std::basic_ostream<char> &) const –> void

type(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocator) → str

Return the name for this class: “FileListResourceLocator”

C++: basic::resource_manager::locator::FileListResourceLocator::type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocatorCreator

Bases: pyrosetta.rosetta.basic.resource_manager.ResourceLocatorCreator

creator for the FileSystemResourceLocator class

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocatorCreator) → None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocatorCreator, : pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocatorCreator) → pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocatorCreator

C++: basic::resource_manager::locator::FileListResourceLocatorCreator::operator=(const class basic::resource_manager::locator::FileListResourceLocatorCreator &) –> class basic::resource_manager::locator::FileListResourceLocatorCreator &

create_resource_locator(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocatorCreator) → pyrosetta.rosetta.basic.resource_manager.ResourceLocator

C++: basic::resource_manager::locator::FileListResourceLocatorCreator::create_resource_locator() const –> class std::shared_ptr<class basic::resource_manager::ResourceLocator>

locator_type(self: pyrosetta.rosetta.basic.resource_manager.locator.FileListResourceLocatorCreator) → str

C++: basic::resource_manager::locator::FileListResourceLocatorCreator::locator_type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.locator.FileStream

Bases: pyrosetta.rosetta.basic.resource_manager.ResourceStream

%FileStream is a wrapper class for a utility::io::izstream object that derives from ResourceStream.

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.FileStream) -> None
2. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.FileStream, arg0: str) -> None

doc

3. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.FileStream, filename: str, open_mode: pyrosetta.rosetta.std._Ios_Openmode) -> None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceStream, : pyrosetta.rosetta.basic.resource_manager.ResourceStream) → pyrosetta.rosetta.basic.resource_manager.ResourceStream

C++: basic::resource_manager::ResourceStream::operator=(const class basic::resource_manager::ResourceStream &) –> class basic::resource_manager::ResourceStream &

open(*args, **kwargs)

Overloaded function.

1. open(self: pyrosetta.rosetta.basic.resource_manager.locator.FileStream, filename: str) -> None
2. open(self: pyrosetta.rosetta.basic.resource_manager.locator.FileStream, filename: str, open_mode: pyrosetta.rosetta.std._Ios_Openmode) -> None

Open a particular file; must be called if the default constructor is used.

C++: basic::resource_manager::locator::FileStream::open(const class std::basic_string<char> &, enum std::_Ios_Openmode) –> void

stream(self: pyrosetta.rosetta.basic.resource_manager.locator.FileStream) → pyrosetta.rosetta.std.istream

Return non-const access to the internal stream so that it can be

used to construct a resource.

C++: basic::resource_manager::locator::FileStream::stream() –> class std::basic_istream<char> &

class pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator

Bases: pyrosetta.rosetta.basic.resource_manager.ResourceLocator

The %FileSystemResourceLocator is responsible for opening a file from the file system given its name (as the “locator tag” in the locate_resource_stream method ) and returning a FileStream object that wraps this file. This FileStream can then be used to construct a resource.

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator) -> None

doc

2. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator, open_mode: pyrosetta.rosetta.std._Ios_Openmode) -> None
3. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator, arg0: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator) -> None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator, : pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator) → pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator

C++: basic::resource_manager::locator::FileSystemResourceLocator::operator=(const class basic::resource_manager::locator::FileSystemResourceLocator &) –> class basic::resource_manager::locator::FileSystemResourceLocator &

get_open_mode(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator) → pyrosetta.rosetta.std._Ios_Openmode

C++: basic::resource_manager::locator::FileSystemResourceLocator::get_open_mode() const –> enum std::_Ios_Openmode

locate_resource_stream(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator, locator_tag: str) → pyrosetta.rosetta.basic.resource_manager.ResourceStream

Construct a FileStream object given a file’s name (its locator_tag)

C++: basic::resource_manager::locator::FileSystemResourceLocator::locate_resource_stream(const class std::basic_string<char> &) const –> class std::shared_ptr<class basic::resource_manager::ResourceStream>

locator_tag(*args, **kwargs)

Overloaded function.

1. locator_tag(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator, locator_tag: str) -> None

Set the name for this %ResourceLocator

C++: basic::resource_manager::ResourceLocator::locator_tag(const class std::basic_string<char> &) –> void

2. locator_tag(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator) -> str

Return the name for this %ResourceLocator

C++: basic::resource_manager::ResourceLocator::locator_tag() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator, tag: utility::tag::Tag) → None

Allows a default base_path to be specified for the locator.

C++: basic::resource_manager::locator::FileSystemResourceLocator::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>) –> void

set_open_mode(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator, open_mode: pyrosetta.rosetta.std._Ios_Openmode) → None

C++: basic::resource_manager::locator::FileSystemResourceLocator::set_open_mode(enum std::_Ios_Openmode) –> void

show(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator, out: pyrosetta.rosetta.std.ostream) → None

C++: basic::resource_manager::locator::FileSystemResourceLocator::show(class std::basic_ostream<char> &) const –> void

type(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocator) → str

C++: basic::resource_manager::locator::FileSystemResourceLocator::type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocatorCreator

Bases: pyrosetta.rosetta.basic.resource_manager.ResourceLocatorCreator

creator for the FileSystemResourceLocator class

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocatorCreator) → None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocatorCreator, : pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocatorCreator) → pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocatorCreator

C++: basic::resource_manager::locator::FileSystemResourceLocatorCreator::operator=(const class basic::resource_manager::locator::FileSystemResourceLocatorCreator &) –> class basic::resource_manager::locator::FileSystemResourceLocatorCreator &

create_resource_locator(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocatorCreator) → pyrosetta.rosetta.basic.resource_manager.ResourceLocator

C++: basic::resource_manager::locator::FileSystemResourceLocatorCreator::create_resource_locator() const –> class std::shared_ptr<class basic::resource_manager::ResourceLocator>

locator_type(self: pyrosetta.rosetta.basic.resource_manager.locator.FileSystemResourceLocatorCreator) → str

C++: basic::resource_manager::locator::FileSystemResourceLocatorCreator::locator_type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocator

Bases: pyrosetta.rosetta.basic.resource_manager.ResourceLocator

The %NullResourceLocator is meant for cases where a resource can be created without reading from an input file. It goes through the motions of returning a ResourceStream (an empty NullStream) as is required of all ResourceLocators, but the stream that it creates will not be used.

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocator) -> None
2. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocator, arg0: pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocator) -> None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocator, : pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocator) → pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocator

C++: basic::resource_manager::locator::NullResourceLocator::operator=(const class basic::resource_manager::locator::NullResourceLocator &) –> class basic::resource_manager::locator::NullResourceLocator &

locate_resource_stream(self: pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocator, locator_tag: str) → pyrosetta.rosetta.basic.resource_manager.ResourceStream

Create an empty NullResource object that will not be used

C++: basic::resource_manager::locator::NullResourceLocator::locate_resource_stream(const class std::basic_string<char> &) const –> class std::shared_ptr<class basic::resource_manager::ResourceStream>

locator_tag(*args, **kwargs)

Overloaded function.

1. locator_tag(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator, locator_tag: str) -> None

Set the name for this %ResourceLocator

C++: basic::resource_manager::ResourceLocator::locator_tag(const class std::basic_string<char> &) –> void

2. locator_tag(self: pyrosetta.rosetta.basic.resource_manager.ResourceLocator) -> str

Return the name for this %ResourceLocator

C++: basic::resource_manager::ResourceLocator::locator_tag() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocator, tag: utility::tag::Tag) → None

Noop, since there is no data in this class.

C++: basic::resource_manager::locator::NullResourceLocator::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>) –> void

show(self: pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocator, out: pyrosetta.rosetta.std.ostream) → None

Describe this instance to the given output stream; since there is no

data in this class, merely print the name of this class.

C++: basic::resource_manager::locator::NullResourceLocator::show(class std::basic_ostream<char> &) const –> void

type(self: pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocator) → str

Return the name of this class: “NullResourceLocator”

C++: basic::resource_manager::locator::NullResourceLocator::type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocatorCreator

Bases: pyrosetta.rosetta.basic.resource_manager.ResourceLocatorCreator

creator for the NullResourceLocator class

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(self: pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocatorCreator) → None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocatorCreator, : pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocatorCreator) → pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocatorCreator

C++: basic::resource_manager::locator::NullResourceLocatorCreator::operator=(const class basic::resource_manager::locator::NullResourceLocatorCreator &) –> class basic::resource_manager::locator::NullResourceLocatorCreator &

create_resource_locator(self: pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocatorCreator) → pyrosetta.rosetta.basic.resource_manager.ResourceLocator

C++: basic::resource_manager::locator::NullResourceLocatorCreator::create_resource_locator() const –> class std::shared_ptr<class basic::resource_manager::ResourceLocator>

locator_type(self: pyrosetta.rosetta.basic.resource_manager.locator.NullResourceLocatorCreator) → str

C++: basic::resource_manager::locator::NullResourceLocatorCreator::locator_type() const –> std::string

class pyrosetta.rosetta.basic.resource_manager.locator.NullStream

Bases: pyrosetta.rosetta.basic.resource_manager.ResourceStream

The %NullStream acts as an empty stream object that may be returned by the NullResourceLocator. It does not open any files.

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(self: pyrosetta.rosetta.basic.resource_manager.locator.NullStream) → None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceStream, : pyrosetta.rosetta.basic.resource_manager.ResourceStream) → pyrosetta.rosetta.basic.resource_manager.ResourceStream

C++: basic::resource_manager::ResourceStream::operator=(const class basic::resource_manager::ResourceStream &) –> class basic::resource_manager::ResourceStream &

stream(self: pyrosetta.rosetta.basic.resource_manager.locator.NullStream) → pyrosetta.rosetta.std.istream

C++: basic::resource_manager::locator::NullStream::stream() –> class std::basic_istream<char> &

class pyrosetta.rosetta.basic.resource_manager.locator.StringResourceStream

Bases: pyrosetta.rosetta.basic.resource_manager.ResourceStream

The %StringResourceStream is a wrapper class for a std::stringstream that can be used to construct a resource. Useful when reading the resource stream in to memory (e.g. from a database or from multiple files) before trying to construct the resource.

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.StringResourceStream) -> None
2. __init__(self: pyrosetta.rosetta.basic.resource_manager.locator.StringResourceStream, contents: str) -> None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.basic.resource_manager.ResourceStream, : pyrosetta.rosetta.basic.resource_manager.ResourceStream) → pyrosetta.rosetta.basic.resource_manager.ResourceStream

C++: basic::resource_manager::ResourceStream::operator=(const class basic::resource_manager::ResourceStream &) –> class basic::resource_manager::ResourceStream &

fill(self: pyrosetta.rosetta.basic.resource_manager.locator.StringResourceStream, contents: str) → None

Construct the stringstream from the given input string.

C++: basic::resource_manager::locator::StringResourceStream::fill(const class std::basic_string<char> &) –> void

stream(self: pyrosetta.rosetta.basic.resource_manager.locator.StringResourceStream) → pyrosetta.rosetta.std.istream

Give non-const access to the internal stringstream so that it can be used to construct a resource.

C++: basic::resource_manager::locator::StringResourceStream::stream() –> class std::basic_istream<char> &