`sardanameta`¶

This module is part of the Python Sardana libray. It defines the base classes for MetaLibrary and MetaClass

Classes

SardanaLibrary

SardanaClass

SardanaLibrary¶

class SardanaLibrary(**kwargs)[source]¶

Object representing a python module containing sardana classes. Public members:

module - reference to python module

file_path - complete (absolute) path (with file name at the end)

file_name - file name (including file extension)

path - complete (absolute) path

name - (=module name) module name (without file extension)

meta_classes - dict<str, SardanMetaClass>

exc_info - exception information if an error occurred when loading

the module

description = '<Undocumented>'¶

module_name¶

Returns the module name for this library.

Returns:	the module name
Return type:	str

code¶

Returns a sequence of sourcelines corresponding to the module code.

Returns:	list of source code lines
Return type:	list<str>

add_meta_class(meta_class)[source]¶

Adds a new :class:~`sardana.sardanameta.SardanaClass` to this library.

Parameters:	meta_class (:class:~`sardana.sardanameta.SardanaClass`) – the meta class to be added to this library

get_meta_class(meta_class_name)[source]¶

Returns a :class:~`sardana.sardanameta.SardanaClass` for the given meta class name or None if the meta class does not exist in this library.

Parameters:	meta_class_name (str) – the meta class name
Returns:	a meta class or None
Return type:	:class:~`sardana.sardanameta.SardanaClass`

get_meta_classes()[source]¶

Returns a sequence of the meta classes that belong to this library.

Returns:	a sequence of meta classes that belong to this library
Return type:	seq<:class:~`sardana.sardanameta.SardanaClass`>

has_meta_class(meta_class_name)[source]¶

Returns True if the given meta class name belongs to this library or False otherwise.

Parameters:	meta_class_name (str) – the meta class name
Returns:	True if the given meta class name belongs to this library or False otherwise
Return type:	bool

add_meta_function(meta_function)[source]¶

Adds a new :class:~`sardana.sardanameta.SardanaFunction` to this library.

Parameters:	meta_function (:class:~`sardana.sardanameta.SardanaFunction`) – the meta function to be added to this library

get_meta_function(meta_function_name)[source]¶

Returns a :class:~`sardana.sardanameta.SardanaFunction` for the given meta function name or None if the meta function does not exist in this library.

Parameters:	meta_function_name (str) – the meta function name
Returns:	a meta function or None
Return type:	:class:~`sardana.sardanameta.SardanaFunction`

get_meta_functions()[source]¶

Returns a sequence of the meta functions that belong to this library.

Returns:	a sequence of meta functions that belong to this library
Return type:	seq<:class:~`sardana.sardanameta.SardanaFunction`>

has_meta_function(meta_function_name)[source]¶

Returns True if the given meta function name belongs to this library or False otherwise.

Parameters:	meta_function_name (str) – the meta function name
Returns:	True if the given meta function name belongs to this library or False otherwise
Return type:	bool

get_meta(meta_name)[source]¶

Returns a :class:~`sardana.sardanameta.SardanaCode` for the given meta name or None if the meta does not exist in this library.

Parameters:	meta_name (str) – the meta name (class, function)
Returns:	a meta or None
Return type:	:class:~`sardana.sardanameta.SardanaCode`

has_meta(meta_name)[source]¶

Returns True if the given meta name belongs to this library or False otherwise.

Parameters:	meta_name (str) – the meta name
Returns:	True if the given meta (class or function) name belongs to this library or False otherwise
Return type:	bool

has_metas()[source]¶

Returns True if any meta object exists in the library or False otherwise.

Returns:	True if any meta object (class or function) exists in the library or False otherwise
Return type:	bool

get_metas()[source]¶

Returns a sequence of the meta (class and functions) that belong to this library.

Returns:	a sequence of meta (class and functions) that belong to this library
Return type:	seq<:class:~`sardana.sardanameta.SardanaCode`>

get_name()[source]¶

Returns the module name for this library (same as :meth:~sardana.sardanameta.SardanaLibrary.get_module_name).

Returns:	the module name
Return type:	str

get_module_name()[source]¶

Returns the module name for this library (same as :meth:~sardana.sardanameta.SardanaLibrary.get_name).

Returns:	the module name
Return type:	str

get_module()[source]¶

Returns the python module for this library.

Returns:	the python module
Return type:	object

get_description()[source]¶

Returns the this library documentation or “<Undocumented>” if no documentation exists.

Returns:	this library documentation or None
Return type:	str

get_code()[source]¶

Returns a sequence of sourcelines corresponding to the module code.

Returns:	list of source code lines
Return type:	list<str>

get_file_path()[source]¶

Returns the file path for this library. On posix systems is something like: /abs/path/filename.py

Returns:	this library file path
Return type:	str

get_file_name()[source]¶

Returns the file name for this library. On posix systems is something like: filename.py

Returns:	this library file name
Return type:	str

has_errors()[source]¶

Returns True if this library has syntax errors or False otherwise.

Returns:	True if this library has syntax errors or False otherwise
Return type:	bool

set_error(exc_info)[source]¶

Sets the error information for this library

Parameters:	exc_info (tuple<type, value, traceback>) – error information. It must be an object similar to the one returned by `sys.exc_info()`

get_error()[source]¶

Gets the error information for this library or None if no error exists

Returns:	error information. An object similar to the one returned by `sys.exc_info()`
Return type:	tuple<type, value, traceback>

serialize(*args, **kwargs)[source]¶

Returns a serializable object describing this object.

Returns:	a serializable dict
Return type:	dict

Critical = 50¶

Debug = 10¶

DftLogLevel = 20¶

DftLogMessageFormat = '%(threadName)-14s %(levelname)-8s %(asctime)s %(name)s: %(message)s'¶

Error = 40¶

Fatal = 50¶

Info = 20¶

Trace = 5¶

Warning = 30¶

add_listener(listener)¶

Adds a new listener for this object.

Parameters:	listener – a listener

are_events_blocked()¶

block_events()¶

fire_event(event_type, event_value, listeners=None, protected=True)¶

flush_queue()¶

frontend¶: the object frontend

full_name¶: object full name

get_frontend()¶

Returns this sardana frontend object or None if no frontend is registered

Returns:	this objects frontend
Return type:	`object`

get_full_name()¶

Returns this sardana object full name

Returns:	this sardana object full name
Return type:	str

get_interface()¶

Returns the interface this object implements.

Returns:	The interface this object implements.
Return type:	`sardana.sardanadefs.Interface`

get_interface_names()¶

Returns a sequence of interface names this object implements.

Returns:	The sequence of interfaces this object implements.
Return type:	sequence<`str`>

get_interfaces()¶

Returns the set of interfaces this object implements.

Returns:	The set of interfaces this object implements.
Return type:	class:set <`sardana.sardanadefs.Interface`>

get_manager()¶

Return the sardana.Manager which owns this sardana object.

Returns:	the manager which owns this pool object.
Return type:	`sardana.Manager`

get_parent()¶

Returns this pool object parent.

Returns:	this objects parent
Return type:	`SardanaBaseObject`

get_parent_name()¶

Returns this sardana object parent’s name.

Returns:	this objects parent
Return type:	str

get_type()¶

Returns this sardana object type.

Returns:	this sardana object type
Return type:	`ElementType`

has_listeners()¶

Returns True if anybody is listening to events from this object

Returns:	True is at least one listener is listening or False otherwise

log_level = 20¶

manager¶: reference to the sardana.Manager

name¶: object name

queue_event(event_type, event_value, listeners=None)¶

remove_listener(listener)¶

Removes an existing listener for this object.

Parameters:	listener – the listener to be removed
Returns:	True is succeeded or False otherwise

root_inited = True¶

serialized(*args, **kwargs)¶

set_name(name)¶

Sets sardana object name

Param:	sardana object name
Type:	str

str(*args, **kwargs)¶

unblock_events()¶

SardanaClass¶

class SardanaClass(**kwargs)[source]¶

Object representing a python class.

Critical = 50¶

Debug = 10¶

DftLogLevel = 20¶

DftLogMessageFormat = '%(threadName)-14s %(levelname)-8s %(asctime)s %(name)s: %(message)s'¶

Error = 40¶

Fatal = 50¶

Info = 20¶

Trace = 5¶

Warning = 30¶

add_listener(listener)¶

Adds a new listener for this object.

Parameters:	listener – a listener

are_events_blocked()¶

block_events()¶

code¶: Returns a tuple (sourcelines, firstline) corresponding to the definition of this code object. sourcelines is a list of source code lines. firstline is the line number of the first source code line.

code_object¶

description = '<Undocumented>'¶

file_name¶

Returns the file name for the library where this class is. On posix systems is something like: filename.py

Returns:	the file name for the library where this class is
Return type:	str

file_path¶

Returns the file path for for the library where this class is. On posix systems is something like: /abs/path/filename.py

Returns:	the file path for for the library where this class is
Return type:	str

fire_event(event_type, event_value, listeners=None, protected=True)¶

flush_queue()¶

frontend¶: the object frontend

full_name¶: object full name

get_brief_description(max_chars=60)¶

get_code()¶: Returns a tuple (sourcelines, firstline) corresponding to the definition of the controller class. sourcelines is a list of source code lines. firstline is the line number of the first source code line.