chemdataextractor

.config

Config file reader/writer.

chemdataextractor.config.construct_yaml_str(self, node)

Override the default string handling function to always return unicode objects.

class chemdataextractor.config.Config(path=None)

Bases: collections.abc.MutableMapping

Read and write to config file.

A config object is essentially a string key-value store that can be treated like a dictionary:

c = Config()
c['foo'] = 'bar'
print c['foo']

The file location may be specified:

c = Config('~/matt/anotherconfig.yml')
c['where'] = 'in a different file'

If no location is specified, the environment variable CHEMDATAEXTRACTOR_CONFIG is checked and used if available. Otherwise, a standard config location is used, which varies depending on the operating system. You can check the location using the path property. For more information see https://github.com/ActiveState/appdirs

It is possible to edit the file by hand with a text editor. It is in YAML format.

Warning: multiple instances of Config() pointing to the same file will not see each others’ changes, and will overwrite the entire file when any key is changed.

__init__(path=None)

Parameters:

path (string) – (Optional) Path to config file location.

path

The path to the config file.

clear()

Clear all values from config.

chemdataextractor.config.config = <Config: /home/docs/.config/ChemDataExtractor/chem...

Global config instance.

.data

Tools for loading and caching data files.

class chemdataextractor.data.Package(path, server_root=None, remote_path=None, unzip=False, untar=False, custom_download=None)

Bases: object

Data package.

__init__(path, server_root=None, remote_path=None, unzip=False, untar=False, custom_download=None)

Parameters:

• path (str) – The path to where this package will be located under ChemDataExtractor’s default data directory.

• (optional) server_root (str) – The root path for the server. If you do not supply the remote_path parameter, this will be used to find the remote path for the package.

• (optional) remote_path (str) – The remote path for the package.

• (optional) unzip (bool) – Whether the package should be unzipped after download. You should only ever set this or untar to True.

• (optional) untar (bool) – Whether the package should be untarred after download. You should only ever set this or unzip to True.

remote_path

local_path

remote_exists()

local_exists()

download(force=False)

default_download(force=False)

chemdataextractor.data.get_data_dir()

Return path to the data directory.

chemdataextractor.data.find_data(path, warn=True, get_data=True)

Return the absolute path to a data file within the data directory.

chemdataextractor.data.load_model(path)

Load a model from a pickle file in the data directory. Cached so model is only loaded once.

chemdataextractor.data.PACKAGES = [<Package: models/cem_crf-1.0.pickle>, <Package: m...

Current active data packages

.errors

Error classes for ChemDataExtractor.

exception chemdataextractor.errors.ChemDataExtractorError

Bases: Exception

Base ChemDataExtractor exception.

exception chemdataextractor.errors.ReaderError

Bases: chemdataextractor.errors.ChemDataExtractorError

Raised when a reader is unable to read a document.

exception chemdataextractor.errors.ModelNotFoundError

Bases: chemdataextractor.errors.ChemDataExtractorError

Raised when a model file could not be found.

.utils

Miscellaneous utility functions.

chemdataextractor.utils.memoized_property(fget)

Decorator to create memoized properties.

chemdataextractor.utils.memoize(obj)

Decorator to create memoized functions, methods or classes.

chemdataextractor.utils.python_2_unicode_compatible(klass)

Fix __str__, __unicode__ and __repr__ methods under Python 2.

class chemdataextractor.utils.Singleton

Bases: type

Singleton metaclass.

chemdataextractor.utils.flatten(x)

Return a single flat list containing elements from nested lists.

chemdataextractor.utils.first(el)

chemdataextractor.utils.ensure_dir(path)

Ensure a directory exists.

previous

API Reference

next

.biblio