Package schrodinger :: Package test :: Package stu :: Module client :: Class TestClient

Class TestClient

 object --+    
          |    
_BaseClient --+
              |
             TestClient

Interact with the Test server. Create, Retrieve, Update, and Delete tests. Also upload and download the associated files.

Instance Methods

[hide private]

__init__(self, username=None, base_url=None, api_version=_VERSION)
x.__init__(...) initializes x; see help(type(x)) for signature

create(self, test)
Create a test.

retrieve(self, test_ids=None, products=None, components=None, priorities=None, tags=None, not_products=tuple(), not_components=tuple(), not_tags=tuple())
Retrieve tests based on some limiting criteria.

update(self, test)
Update files and metadata for a test.

delete(self, test)
Delete a test metadata and files.

download(self, test, directory=None, overwrite=True)
Download and extract the files associated with test.

upload(self, test, directory=None)
Upload a directory to the server.

_setTestDir(self, test, directory=None)

_setSharedFiles(self, shared_files)
Upload shared files to server.

_getTestDir(self, test, directory=None, overwrite=True)
Download the zipped test file and extract it to a directory.

_getSharedFiles(self, shared_files, overwrite=False)
Download the shared files.

Inherited from _BaseClient: auth, fullapi, get, getResourceURI, item_uri, list2str, patch, post, put, safename

Inherited from _BaseClient (private): _request

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods

[hide private]

Inherited from _BaseClient: instance

Class Variables

[hide private]

Inherited from _BaseClient (private): _INSTANCE

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, username=None, base_url=None, api_version=_VERSION)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

retrieve(self, test_ids=None, products=None, components=None, priorities=None, tags=None, not_products=tuple(), not_components=tuple(), not_tags=tuple())

Retrieve tests based on some limiting criteria. The only method that operates on more than one test at a time. A bit weird?

delete(self, test)

Delete a test metadata and files.

Overrides: _BaseClient.delete

download(self, test, directory=None, overwrite=True)

Download and extract the files associated with test. Overwrites existing contents of the directory.

upload(self, test, directory=None)

Upload a directory to the server. If the test has a directory attribute, use that. Otherwise, based on the test number.

Class TestClient

__init__(self, username=None, base_url=None, api_version=_VERSION) (Constructor)

retrieve(self, test_ids=None, products=None, components=None, priorities=None, tags=None, not_products=tuple(), not_components=tuple(), not_tags=tuple())

delete(self, test)

download(self, test, directory=None, overwrite=True)

upload(self, test, directory=None)

init(self, username=None, base_url=None, api_version=_VERSION)
(Constructor)