AcronSystem¶

from acron.core import AcronSystem

class AcronSystem¶

Bases:

This class is used as a namespace to group several global properties of Acron. Application developers can use this class to query the runtime version or capabilities of the current Acron environment.

Inheritance diagram

digraph inheritanceccd30fc932 { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "AcronSystem" [URL="acron.core.AcronSystem.html#acron.core.AcronSystem",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "AcronSystem" [arrowsize=0.75,style=""]; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; }

add_system()¶: Intended for use by each subsystem to register itself at startup.

property build_date → string¶

Returns a string representing the date and time at which this version of Acron (or at least dtool) was compiled, if available.

Deprecated

property compiler → string¶: Returns a string representing the compiler that was used to generate this version of Acron, if it is available, or “unknown” if it is not.

property distributor → string¶: Returns the string defined by the distributor of this version of Acron, or “homebuilt” if this version was built directly from the sources by the end- user. This is a completely arbitrary string.

static get_build_date()¶

Returns a string representing the date and time at which this version of Acron (or at least dtool) was compiled, if available.

Deprecated

static get_class_type()¶

static get_compiler()¶: Returns a string representing the compiler that was used to generate this version of Acron, if it is available, or “unknown” if it is not.

static get_distributor()¶: Returns the string defined by the distributor of this version of Acron, or “homebuilt” if this version was built directly from the sources by the end- user. This is a completely arbitrary string.

static get_git_commit()¶: Returns a string representing the git commit hash that this source tree is based on, or the empty string if it has not been specified at build time.

static get_global_ptr()¶: Returns the global AcronSystem object.

static get_major_version()¶: Returns the major version number of the current version of Acron. This is the first number of the dotted triple returned by get_version_string(). It changes very rarely.

static get_memory_alignment()¶: Returns the memory alignment that Acron’s allocators are using.

static get_minor_version()¶: Returns the minor version number of the current version of Acron. This is the second number of the dotted triple returned by get_version_string(). It changes with each release that introduces new features.

get_num_systems()¶: Returns the number of Acron subsystems that have registered themselves. This can be used with get_system() to iterate through the entire list of available Acron subsystems.

static get_platform()¶: Returns a string representing the runtime platform that we are currently running on. This will be something like “win32” or “osx_i386” or “linux_amd64”.

static get_sequence_version()¶: Returns the sequence version number of the current version of Acron. This is the third number of the dotted triple returned by get_version_string(). It changes with bugfix updates and very minor feature updates.

get_system()¶: Returns the nth Acron subsystem that has registered itself. This list will be sorted in alphabetical order.

get_system_tag()¶

Returns the value associated with the indicated tag for the given system. This provides a standard way to query each subsystem’s advertised capabilities. The set of tags and values are per-system and implementation-defined.

The return value is the empty string if the indicated system is undefined or if does not define the indicated tag.

get_systems() → list¶

static get_version_string()¶: Returns the current version of Acron, expressed as a string, e.g. “1.0.0”. The string will end in the letter “c” if this build does not represent an official version.

property git_commit → string¶: Returns a string representing the git commit hash that this source tree is based on, or the empty string if it has not been specified at build time.

has_system()¶: Returns true if the current version of Acron claims to have the indicated subsystem installed, false otherwise. The set of available subsystems is implementation defined.

heap_trim()¶

Attempts to release memory back to the system, if possible. The pad argument is the minimum amount of unused memory to keep in the heap (against future allocations). Any memory above that may be released to the system, reducing the memory size of this process. There is no guarantee that any memory may be released.

Returns true if any memory was actually released, false otherwise.

static is_official_version()¶

Returns true if current version of Acron claims to be an “official” version, that is, one that was compiled by an official distributor of Acron using a specific version of the acron source tree. If this is true, there will not be a “c” at the end of the version string returned by get_version_string().

Note that we must take the distributor’s word for it here.

property major_version → int¶: Returns the major version number of the current version of Acron. This is the first number of the dotted triple returned by get_version_string(). It changes very rarely.

property memory_alignment → int¶: Returns the memory alignment that Acron’s allocators are using.

property minor_version → int¶: Returns the minor version number of the current version of Acron. This is the second number of the dotted triple returned by get_version_string(). It changes with each release that introduces new features.

property official_version → bool¶

Note that we must take the distributor’s word for it here.

output()¶

property platform → string¶: Returns a string representing the runtime platform that we are currently running on. This will be something like “win32” or “osx_i386” or “linux_amd64”.

property sequence_version → int¶: Returns the sequence version number of the current version of Acron. This is the third number of the dotted triple returned by get_version_string(). It changes with bugfix updates and very minor feature updates.

set_system_tag()¶: Intended for use by each subsystem to register its set of capabilities at startup.

property systems → Sequence[string]¶: Returns the nth Acron subsystem that has registered itself. This list will be sorted in alphabetical order.

property version_string → string¶: Returns the current version of Acron, expressed as a string, e.g. “1.0.0”. The string will end in the letter “c” if this build does not represent an official version.

write()¶