Common utilities

General functions and classes shared in the codebase

General functions

xl.common.log_exception(log=<logging.Logger object>, message='Exception caught!')

Deprecated! Don’t use this in newer code, use this instead:

import logging
logger = logging.getLogger(__name__)

..

try:
    ..
except Exception:
    logger.exception("Some message: %s", param)

xl.common.order_poset(items)

Parameters:items (list of PosetItem) – poset to order

Filesystem

xl.common.open_file(path)

Opens a file or folder using the system configured program

xl.common.open_file_directory(path_or_uri)

Opens the parent directory of a file, selecting the file if possible.

xl.common.walk(root)

Walk through a Gio directory, yielding each file

Files are enumerated in the following order: first the directory, then the files in that directory. Once one directory’s files have all been listed, it moves on to the next directory. Order of files within a directory and order of directory traversal is not specified.

Parameters:root – a Gio.File representing the directory to walk through Returns:a generator object Return type:Gio.File

xl.common.walk_directories(root)

Walk through a Gio directory, yielding each subdirectory

Parameters:root – a Gio.File representing the directory to walk through Returns:a generator object Return type:Gio.File

Decorators

xl.common.threaded(func)

A decorator that will make any function run in a new thread

Parameters:func – the function to run threaded

xl.common.synchronized(func)

A decorator to make a function synchronized - which means only one thread is allowed to access it at a time.

This only works on class functions, and creates a variable in the instance called _sync_lock.

If this function is used on multiple functions in an object, they will be locked with respect to each other. The lock is re-entrant.

xl.common.profileit(func)

Decorator to profile a function

xl.common.classproperty(function)

Decorator allowing for class property access

xl.common.cached(limit)

Decorator to make a function’s results cached does not cache if there is an exception.

Note

This probably breaks on functions that modify their arguments

Classes

exception xl.common.VersionError(message)

class xl.common.LimitedCache(limit)

Bases: UserDict.DictMixin

Simple cache that acts much like a dict, but has a maximum # of items

class xl.common.TimeSpan(span)

Calculates the number of days, hours, minutes, and seconds in a time span

days = 0

number of days

hours = 0

number of hours

minutes = 0

number of minutes

seconds = 0

number of seconds

class xl.common.MetadataList(iterable=[], metadata=[])

Like a list, but also associates an object of metadata with each entry.

(get|set|del)_meta_key are the metadata interface - they allow the metadata to act much like a dictionary, with a few optimizations.

List aspects that are not supported:

• sort
• comparisons other than equality
• multiply

xl.common.ProgressThread

alias of mocks.

class xl.common.PosetItem(name, after, priority, value=None)