Package pology :: Module ascript :: Class AscConfig

Class AscConfig

object --+
         |
        AscConfig

Representation of an ascription configuration file.

The settings are reached through class attributes. Some attributes are raw data read from configuration fields, while other may be derived based on configuration fields.

Parameters which have "for header updates" in their description are used for creating and updating ascription catalog headers, as well as original catalog headers when header update on commit is requested. They may contain a number of interpolations, see Catalog.update_header.

Instance Methods
 
__init__(self, cfgpath)
Constructor.

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

Instance Variables
string ascroot
the path to root directory of ascription catalogs
string catroot
the path to root directory of original catalogs
string or None commitmsg
the automatic commit message
string or None langcode
the language code (for header updates)
string or None langteam
the language team name (for header updates)
string path
the path to the ascription configuration file
string or None plforms
the PO plural forms specification (for header updates)
set(string*) revtags
known review tags (empty string always included)
string or None teamemail
the language team email address (for header updates)
string or None title
the header title comment (for header updates; only for original catalogs)
{string: AscUser*} users
data for ascription users by username
VcsBase vcs
the version control system for catalogs
Properties

Inherited from object: __class__

Method Details

__init__(self, cfgpath)
(Constructor)

 

Constructor.

Reads the ascription configuration file to set raw and derived ascription settings.

Parameters:
  • cfgpath (string) - the path to ascription configuration file
Overrides: object.__init__