| Trees | Indices | Help |
|
|---|
|
|
object --+
|
core.Component --+
|
object --+ |
| |
core.ComponentManager --+
|
Environment
Trac environment manager. Trac stores project information in a Trac environment. It consists of a directory structure containing among other things: * a configuration file * an SQLite database (stores tickets, wiki pages...) * project-specific templates and plugins * wiki and ticket attachments
| Nested Classes | |
|
Inherited from |
| Instance Methods | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Inherited from Inherited from |
|||
| Static Methods | |
|
Inherited from |
| Class Variables | |
base_url = <Option [trac] "base_url">
|
|
base_url_for_redirect = <BoolOption [trac] "use_base_url_for_r
|
|
log_file = <Option [logging] "log_file">
|
|
log_format = <Option [logging] "log_format">
|
|
log_level = <Option [logging] "log_level">
|
|
log_type = <Option [logging] "log_type">
|
|
project_admin = <Option [project] "admin">
|
|
project_admin_trac_url = <Option [project] "admin_trac_url">
|
|
project_description = <Option [project] "descr">
|
|
project_footer = <Option [project] "footer">
|
|
project_icon = <Option [project] "icon">
|
|
project_name = <Option [project] "name">
|
|
project_url = <Option [project] "url">
|
|
required = True
|
|
secure_cookies = <BoolOption [trac] "secure_cookies">
|
|
shared_plugins_dir = <PathOption [inherit] "plugins_dir">
|
|
| Properties | |
| abs_href | |
| href | |
|
setup_participants List of components that implement IEnvironmentSetupParticipant |
|
|
system_info_providers List of components that implement ISystemInfoProvider |
|
|
Inherited from |
|
| Method Details |
Initialize the Trac environment.
@param path: the absolute path to the Trac environment
@param create: if `True`, the environment is created and populated with
default data; otherwise, the environment is expected to
already exist.
@param options: A list of `(section, name, value)` tuples that define
configuration options
|
Simple SQLite-specific backup of the database.
|
Initialize additional member variables for components. Every component activated through the Environment object gets three member variables: env (the environment object), config (the environment configuration) and log (a logger object).
|
Create the basic directory structure of the environment, initialize the database and populate the configuration file with default values. If options contains ('inherit', 'file'), default values will not be loaded; they are expected to be provided by that file or other options. |
Return a database connection from the connection pool (deprecated) Use with_transaction for obtaining a writable database connection and get_read_db for anything else. |
Generator that yields information about all known users, i.e. users that have logged in to this Trac environment and possibly set their name and email. This function generates one tuple for every user, of the form (username, name, email) ordered alpha-numerically by username.
|
Return a database connection for read purposes. See trac.db.api.get_read_db for detailed documentation. |
Return the version control repository with the given name, or the
default repository if `None`.
The standard way of retrieving repositories is to use the methods
of `RepositoryManager`. This method is retained here for backward
compatibility.
@param reponame: the name of the repository
@param authname: the user name for authorization (not used anymore,
left here for compatibility with 0.11)
|
Return the current version of the database.
If the optional argument In practice, for database created before 0.11, this will return |
Implemented to only allow activation of components that are not disabled in the configuration. This is called by the ComponentManager base class when a component is
about to be activated. If this method returns
|
Upgrade database. @param backup: whether or not to backup before upgrading @param backup_dest: name of the backup file @return: whether the upgrade was performed |
Decorator for transaction functions. See trac.db.api.with_transaction for detailed documentation. |
| Class Variable Details |
base_url_for_redirect
|
| Property Details |
abs_href
|
href
|
setup_participantsList of components that implement IEnvironmentSetupParticipant
|
system_info_providersList of components that implement ISystemInfoProvider
|
| Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0.1 on Thu Nov 18 22:48:33 2010 | http://epydoc.sourceforge.net |