INSTRUCTION
stringlengths
1
8.43k
RESPONSE
stringlengths
75
104k
Returns the device size in the given units. Default units are MiB.
def dev_size(self, units="MiB"): """ Returns the device size in the given units. Default units are MiB. *Args:* * units (str): Unit label ('MiB', 'GiB', etc...). Default is MiB. """ self.open() size = lvm_pv_get_dev_size(self.handle) self.close...
Returns the free size in the given units. Default units are MiB.
def free(self, units="MiB"): """ Returns the free size in the given units. Default units are MiB. *Args:* * units (str): Unit label ('MiB', 'GiB', etc...). Default is MiB. """ self.open() size = lvm_pv_get_free(self.handle) self.close() ...
A wrapper function to validate formdata against mongoengine - field validator and raise a proper django. forms ValidationError if there are any problems.
def mongoengine_validate_wrapper(old_clean, new_clean): """ A wrapper function to validate formdata against mongoengine-field validator and raise a proper django.forms ValidationError if there are any problems. """ def inner_validate(value): value = old_clean(value) try: ...
walk through the available valid fields..
def iter_valid_fields(meta): """walk through the available valid fields..""" # fetch field configuration and always add the id_field as exclude meta_fields = getattr(meta, 'fields', ()) meta_exclude = getattr(meta, 'exclude', ()) meta_exclude += (meta.document._meta.get('id_field'),) # walk th...
This function behaves like L { axiom. attributes. reference } but with an extra behaviour: when this item is installed ( via L { axiom. dependency. installOn } on a target item the type named here will be instantiated and installed on the target as well.
def dependsOn(itemType, itemCustomizer=None, doc='', indexed=True, whenDeleted=reference.NULLIFY): """ This function behaves like L{axiom.attributes.reference} but with an extra behaviour: when this item is installed (via L{axiom.dependency.installOn} on a target item, the type named h...
Remove this object from the target as well as any dependencies that it automatically installed which were not explicitly pinned by calling install and raising an exception if anything still depends on this.
def uninstallFrom(self, target): """ Remove this object from the target, as well as any dependencies that it automatically installed which were not explicitly "pinned" by calling "install", and raising an exception if anything still depends on this. """ #did this class powerup on any interf...
If this item is installed on another item return the install target. Otherwise return None.
def installedOn(self): """ If this item is installed on another item, return the install target. Otherwise return None. """ try: return self.store.findUnique(_DependencyConnector, _DependencyConnector.installee == self ...
Return an iterable of things installed on the target that require this item.
def installedDependents(self, target): """ Return an iterable of things installed on the target that require this item. """ for dc in self.store.query(_DependencyConnector, _DependencyConnector.target == target): depends = dependentsOf(dc.installee.__class__) ...
Return an iterable of things installed on the target that this item requires and are not required by anything else.
def installedUniqueRequirements(self, target): """ Return an iterable of things installed on the target that this item requires and are not required by anything else. """ myDepends = dependentsOf(self.__class__) #XXX optimize? for dc in self.store.query(_DependencyConnector, ...
Return an iterable of things installed on the target that this item requires.
def installedRequirements(self, target): """ Return an iterable of things installed on the target that this item requires. """ myDepends = dependentsOf(self.__class__) for dc in self.store.query(_DependencyConnector, _DependencyConnector.target == target): ...
Adapt a store to L { IServiceCollection }.
def storeServiceSpecialCase(st, pups): """ Adapt a store to L{IServiceCollection}. @param st: The L{Store} to adapt. @param pups: A list of L{IServiceCollection} powerups on C{st}. @return: An L{IServiceCollection} which has all of C{pups} as children. """ if st.parent is not None: ...
This function creates ( or returns a previously created ) L { IScheduler } powerup.
def _schedulerServiceSpecialCase(empowered, pups): """ This function creates (or returns a previously created) L{IScheduler} powerup. If L{IScheduler} powerups were found on C{empowered}, the first of those is given priority. Otherwise, a site L{Store} or a user L{Store} will have any pre-exis...
Format a schema mismatch for human consumption.
def _diffSchema(diskSchema, memorySchema): """ Format a schema mismatch for human consumption. @param diskSchema: The on-disk schema. @param memorySchema: The in-memory schema. @rtype: L{bytes} @return: A description of the schema differences. """ diskSchema = set(diskSchema) memo...
Close this file and commit it to its permanent location.
def close(self): """ Close this file and commit it to its permanent location. @return: a Deferred which fires when the file has been moved (and backed up to tertiary storage, if necessary). """ now = time.time() try: file.close(self) _mkdi...
A debugging API exposing SQLite s I { EXPLAIN } statement.
def explain(self): """ A debugging API, exposing SQLite's I{EXPLAIN} statement. While this is not a private method, you also probably don't have any use for it unless you understand U{SQLite opcodes<http://www.sqlite.org/opcode.html>} very well. Once you do, it can be h...
Generate the SQL string which follows the FROM string and before the WHERE string in the final SQL statement.
def _computeFromClause(self, tables): """ Generate the SQL string which follows the "FROM" string and before the "WHERE" string in the final SQL statement. """ tableAliases = [] self.fromClauseParts = [] for table in tables: # The indirect calls to sto...
Return a generator which yields the massaged results of this query with a particular SQL verb.
def _selectStuff(self, verb='SELECT'): """ Return a generator which yields the massaged results of this query with a particular SQL verb. For an attribute query, massaged results are of the type of that attribute. For an item query, they are items of the type the query is ...
This method is deprecated a holdover from when queries were iterators rather than iterables.
def next(self): """ This method is deprecated, a holdover from when queries were iterators, rather than iterables. @return: one element of massaged data. """ if self._selfiter is None: warnings.warn( "Calling 'next' directly on a query is depr...
Split up the work of gathering a result set into multiple smaller pages allowing very large queries to be iterated without blocking for long periods of time.
def paginate(self, pagesize=20): """ Split up the work of gathering a result set into multiple smaller 'pages', allowing very large queries to be iterated without blocking for long periods of time. While simply iterating C{paginate()} is very similar to iterating a query...
Convert a row into an Item instance by loading cached items or creating new ones based on query results.
def _massageData(self, row): """ Convert a row into an Item instance by loading cached items or creating new ones based on query results. @param row: an n-tuple, where n is the number of columns specified by my item type. @return: an instance of the type specified by th...
Get an L { iaxiom. IQuery } whose results will be values of a single attribute rather than an Item.
def getColumn(self, attributeName, raw=False): """ Get an L{iaxiom.IQuery} whose results will be values of a single attribute rather than an Item. @param attributeName: a L{str}, the name of a Python attribute, that describes a column on the Item subclass that this query was spe...
Delete all the Items which are found by this query.
def deleteFromStore(self): """ Delete all the Items which are found by this query. """ if (self.limit is None and not isinstance(self.sort, attributes.UnspecifiedOrdering)): # The ORDER BY is pointless here, and SQLite complains about it. return self.c...
Return a list of tables involved in this query first checking that no required tables ( those in the query target ) have been omitted from the comparison.
def _involvedTables(self): """ Return a list of tables involved in this query, first checking that no required tables (those in the query target) have been omitted from the comparison. """ # SQL and arguments if self.comparison is not None: tables = se...
Convert a row into a tuple of Item instances by slicing it according to the number of columns for each instance and then proceeding as for ItemQuery. _massageData.
def _massageData(self, row): """ Convert a row into a tuple of Item instances, by slicing it according to the number of columns for each instance, and then proceeding as for ItemQuery._massageData. @param row: an n-tuple, where n is the total number of columns specified...
Clone the original query which this distinct query wraps and return a new wrapper around that clone.
def cloneQuery(self, limit=_noItem, sort=_noItem): """ Clone the original query which this distinct query wraps, and return a new wrapper around that clone. """ newq = self.query.cloneQuery(limit=limit, sort=sort) return self.__class__(newq)
Count the number of distinct results of the wrapped query.
def count(self): """ Count the number of distinct results of the wrapped query. @return: an L{int} representing the number of distinct results. """ if not self.query.store.autocommit: self.query.store.checkpoint() target = ', '.join([ tableClass.s...
Convert a raw database row to the type described by an attribute. For example convert a database integer into an L { extime. Time } instance for an L { attributes. timestamp } attribute.
def _massageData(self, row): """ Convert a raw database row to the type described by an attribute. For example, convert a database integer into an L{extime.Time} instance for an L{attributes.timestamp} attribute. @param row: a 1-tuple, containing the in-database value from my ...
Return the sum of all the values returned by this query. If no results are specified return None.
def sum(self): """ Return the sum of all the values returned by this query. If no results are specified, return None. Note: for non-numeric column types the result of this method will be nonsensical. @return: a number or None. """ res = self._runQuery('...
Return the average value ( as defined by the AVG implementation in the database ) of the values specified by this query.
def average(self): """ Return the average value (as defined by the AVG implementation in the database) of the values specified by this query. Note: for non-numeric column types the result of this method will be nonsensical. @return: a L{float} representing the 'average'...
attach a child database returning an identifier for it
def _attachChild(self, child): "attach a child database, returning an identifier for it" self._childCounter += 1 databaseName = 'child_db_%d' % (self._childCounter,) self._attachedChildren[databaseName] = child # ATTACH DATABASE statements can't use bind paramaters, blech. ...
Called during __init__. Check consistency of schema in database with classes in memory. Load all Python modules for stored items and load version information for upgrader service to run later.
def _startup(self): """ Called during __init__. Check consistency of schema in database with classes in memory. Load all Python modules for stored items, and load version information for upgrader service to run later. """ typesToCheck = [] for oid, module, type...
Usage::
def findOrCreate(self, userItemClass, __ifnew=None, **attrs): """ Usage:: s.findOrCreate(userItemClass [, function] [, x=1, y=2, ...]) Example:: class YourItemType(Item): a = integer() b = text() c = integer() ...
Open a new file somewhere in this Store s file area.
def newFile(self, *path): """ Open a new file somewhere in this Store's file area. @param path: a sequence of path segments. @return: an L{AtomicFile}. """ assert len(path) > 0, "newFile requires a nonzero number of segments" if self.dbdir is None: i...
Load all of the stored schema information for all types known by this store. It s important to load everything all at once ( rather than loading the schema for each type separately as it is needed ) to keep store opening fast. A single query with many results is much faster than many queries with a few results each.
def _loadTypeSchema(self): """ Load all of the stored schema information for all types known by this store. It's important to load everything all at once (rather than loading the schema for each type separately as it is needed) to keep store opening fast. A single query with ma...
Called for all known types at database startup: make sure that what we know ( in memory ) about this type agrees with what is stored about this type in the database.
def _checkTypeSchemaConsistency(self, actualType, onDiskSchema): """ Called for all known types at database startup: make sure that what we know (in memory) about this type agrees with what is stored about this type in the database. @param actualType: A L{MetaItem} instance whic...
Note that this database contains old versions of a particular type. Create the appropriate dummy item subclass and queue the type to be upgraded.
def _prepareOldVersionOf(self, typename, version, persistedSchema): """ Note that this database contains old versions of a particular type. Create the appropriate dummy item subclass and queue the type to be upgraded. @param typename: The I{typeName} associated with the schema f...
Find an Item in the database which should be unique. If it is found return it. If it is not found return default if it was passed otherwise raise L { errors. ItemNotFound }. If more than one item is found raise L { errors. DuplicateUniqueItem }.
def findUnique(self, tableClass, comparison=None, default=_noItem): """ Find an Item in the database which should be unique. If it is found, return it. If it is not found, return 'default' if it was passed, otherwise raise L{errors.ItemNotFound}. If more than one item is found...
Usage::
def findFirst(self, tableClass, comparison=None, offset=None, sort=None, default=None): """ Usage:: s.findFirst(tableClass [, query arguments except 'limit']) Example:: class YourItemType(Item): a = integer() b = text()...
Return a generator of instances of C { tableClass } or tuples of instances if C { tableClass } is a tuple of classes.
def query(self, tableClass, comparison=None, limit=None, offset=None, sort=None): """ Return a generator of instances of C{tableClass}, or tuples of instances if C{tableClass} is a tuple of classes. Examples:: fastCars = s.query(Vehicle, ...
Create multiple items in the store without loading corresponding Python objects into memory.
def batchInsert(self, itemType, itemAttributes, dataRows): """ Create multiple items in the store without loading corresponding Python objects into memory. the items' C{stored} callback will not be called. Example:: myData = [(37, u"Fred", u"Wichita"), ...
An item in this store was changed. Add it to the current transaction s list of changed items if a transaction is currently underway or raise an exception if this L { Store } is currently in a state which does not allow changes.
def changed(self, item): """ An item in this store was changed. Add it to the current transaction's list of changed items, if a transaction is currently underway, or raise an exception if this L{Store} is currently in a state which does not allow changes. """ if ...
Execute C { f ( * a ** k ) } in the context of a database transaction.
def transact(self, f, *a, **k): """ Execute C{f(*a, **k)} in the context of a database transaction. Any changes made to this L{Store} by C{f} will be committed when C{f} returns. If C{f} raises an exception, those changes will be reverted instead. If a transaction is a...
Return the unqualified ( ie no database name ) name of the given attribute of the given table.
def _indexNameOf(self, tableClass, attrname): """ Return the unqualified (ie, no database name) name of the given attribute of the given table. @type tableClass: L{MetaItem} @param tableClass: The Python class associated with a table in the database. @param ...
Retrieve the fully qualified name of the table holding items of a particular class in this store. If the table does not exist in the database it will be created as a side - effect.
def getTableName(self, tableClass): """ Retrieve the fully qualified name of the table holding items of a particular class in this store. If the table does not exist in the database, it will be created as a side-effect. @param tableClass: an Item subclass @raises axiom...
Retreive the fully qualified column name for a particular attribute in this store. The attribute must be bound to an Item subclass ( its type must be valid ). If the underlying table does not exist in the database it will be created as a side - effect.
def getColumnName(self, attribute): """ Retreive the fully qualified column name for a particular attribute in this store. The attribute must be bound to an Item subclass (its type must be valid). If the underlying table does not exist in the database, it will be created as a ...
Retrieve the typeID associated with a particular table in the in - database schema for this Store. A typeID is an opaque integer representing the Item subclass and the associated table in this Store s SQLite database.
def getTypeID(self, tableClass): """ Retrieve the typeID associated with a particular table in the in-database schema for this Store. A typeID is an opaque integer representing the Item subclass, and the associated table in this Store's SQLite database. @param tableClas...
Execute the table creation DDL for an Item subclass.
def _justCreateTable(self, tableClass): """ Execute the table creation DDL for an Item subclass. Indexes are *not* created. @type tableClass: type @param tableClass: an Item subclass """ sqlstr = [] sqlarg = [] # needs to be calculated including...
A type ID has been requested for an Item subclass whose table was not present when this Store was opened. Attempt to create the table and if that fails because another Store object ( perhaps in another process ) has created the table re - read the schema. When that s done return the typeID.
def _maybeCreateTable(self, tableClass, key): """ A type ID has been requested for an Item subclass whose table was not present when this Store was opened. Attempt to create the table, and if that fails because another Store object (perhaps in another process) has created the ta...
Create any indexes which don t exist and are required by the schema defined by C { tableClass }.
def _createIndexesFor(self, tableClass, extantIndexes): """ Create any indexes which don't exist and are required by the schema defined by C{tableClass}. @param tableClass: A L{MetaItem} instance which may define a schema which includes indexes. @param extantIndexes...
Retrieve an item by its storeID and return it.
def getItemByID(self, storeID, default=_noItem, autoUpgrade=True): """ Retrieve an item by its storeID, and return it. Note: most of the failure modes of this method are catastrophic and should not be handled by application code. The only one that application programmers should...
For use with SELECT ( or SELECT - like PRAGMA ) statements.
def querySQL(self, sql, args=()): """For use with SELECT (or SELECT-like PRAGMA) statements. """ if self.debug: result = timeinto(self.queryTimes, self._queryandfetch, sql, args) else: result = self._queryandfetch(sql, args) return result
For use with auto - committing statements such as CREATE TABLE or CREATE INDEX.
def createSQL(self, sql, args=()): """ For use with auto-committing statements such as CREATE TABLE or CREATE INDEX. """ before = time.time() self._execSQL(sql, args) after = time.time() if after - before > 2.0: log.msg('Extremely long CREATE: ...
For use with UPDATE or INSERT statements.
def executeSQL(self, sql, args=()): """ For use with UPDATE or INSERT statements. """ sql = self._execSQL(sql, args) result = self.cursor.lastRowID() if self.executedThisTransaction is not None: self.executedThisTransaction.append((result, sql, args)) ...
given a filename to a file containing a __counter__ variable open it read the count add one rewrite the file.
def updateVersion(fname): """ given a filename to a file containing a __counter__ variable, open it, read the count, add one, rewrite the file. This: __counter__=123 Becomes: __counter__=124 """ fname=os.path.abspath(fname) if not os.path.exists(fname): print("c...
Add the scheduler attribute to the given L { _SubSchedulerParentHook }.
def upgradeParentHook1to2(oldHook): """ Add the scheduler attribute to the given L{_SubSchedulerParentHook}. """ newHook = oldHook.upgradeVersion( oldHook.typeName, 1, 2, loginAccount=oldHook.loginAccount, scheduledAt=oldHook.scheduledAt, scheduler=oldHook.store.findFirst...
Copy C { loginAccount } to C { subStore } and remove the installation marker.
def upgradeParentHook3to4(old): """ Copy C{loginAccount} to C{subStore} and remove the installation marker. """ new = old.upgradeVersion( old.typeName, 3, 4, subStore=old.loginAccount) uninstallFrom(new, new.store) return new
Run my runnable and reschedule or delete myself based on its result. Must be run in a transaction.
def invokeRunnable(self): """ Run my runnable, and reschedule or delete myself based on its result. Must be run in a transaction. """ runnable = self.runnable if runnable is None: self.deleteFromStore() else: try: self.runni...
An error occurred running my runnable. Check my runnable for an error - handling method called timedEventErrorHandler that will take the given failure as an argument and execute that if available: otherwise create a TimedEventFailureLog with information about what happened to this event.
def handleError(self, now, failureObj): """ An error occurred running my runnable. Check my runnable for an error-handling method called 'timedEventErrorHandler' that will take the given failure as an argument, and execute that if available: otherwise, create a TimedEventFailureLog with...
Remove from given item from the schedule.
def unscheduleFirst(self, runnable): """ Remove from given item from the schedule. If runnable is scheduled to run multiple times, only the temporally first is removed. """ for evt in self.store.query(TimedEvent, TimedEvent.runnable == runnable, sort=TimedEvent.time.asce...
Return an iterable of the times at which the given item is scheduled to run.
def scheduledTimes(self, runnable): """ Return an iterable of the times at which the given item is scheduled to run. """ events = self.store.query( TimedEvent, TimedEvent.runnable == runnable) return (event.time for event in events if not event.running)
Start calling persistent timed events whose time has come.
def startService(self): """ Start calling persistent timed events whose time has come. """ super(_SiteScheduler, self).startService() self._transientSchedule(self.now(), self.now())
Stop calling persistent timed events.
def stopService(self): """ Stop calling persistent timed events. """ super(_SiteScheduler, self).stopService() if self.timer is not None: self.timer.cancel() self.timer = None
If the service is currently running schedule a tick to happen no later than C { when }.
def _transientSchedule(self, when, now): """ If the service is currently running, schedule a tick to happen no later than C{when}. @param when: The time at which to tick. @type when: L{epsilon.extime.Time} @param now: The current time. @type now: L{epsilon.extim...
If this service s store is attached to its parent ask the parent to schedule this substore to tick at the given time.
def _transientSchedule(self, when, now): """ If this service's store is attached to its parent, ask the parent to schedule this substore to tick at the given time. @param when: The time at which to tick. @type when: L{epsilon.extime.Time} @param now: Present for signatu...
Remove the components in the site store for this SubScheduler.
def migrateDown(self): """ Remove the components in the site store for this SubScheduler. """ subStore = self.store.parent.getItemByID(self.store.idInParent) ssph = self.store.parent.findUnique( _SubSchedulerParentHook, _SubSchedulerParentHook.subStore == ...
Recreate the hooks in the site store to trigger this SubScheduler.
def migrateUp(self): """ Recreate the hooks in the site store to trigger this SubScheduler. """ te = self.store.findFirst(TimedEvent, sort=TimedEvent.time.descending) if te is not None: self._transientSchedule(te.time, None)
Whenever L { Scheduler } or L { SubScheduler } is created either newly or when loaded from a database emit a deprecation warning referring people to L { IScheduler }.
def activate(self): """ Whenever L{Scheduler} or L{SubScheduler} is created, either newly or when loaded from a database, emit a deprecation warning referring people to L{IScheduler}. """ # This is unfortunate. Perhaps it is the best thing which works (it is # th...
Ensure that this hook is scheduled to run at or before C { when }.
def _schedule(self, when): """ Ensure that this hook is scheduled to run at or before C{when}. """ sched = IScheduler(self.store) for scheduledAt in sched.scheduledTimes(self): if when < scheduledAt: sched.reschedule(self, scheduledAt, when) ...
Tokenize a text index a term matrix and build out a graph.
def build_graph(path, term_depth=1000, skim_depth=10, d_weights=False, **kwargs): """ Tokenize a text, index a term matrix, and build out a graph. Args: path (str): The file path. term_depth (int): Consider the N most frequent terms. skim_depth (int): Connect each w...
Render a spring layout.
def draw_spring(self, **kwargs): """ Render a spring layout. """ nx.draw_spring( self.graph, with_labels=True, font_size=10, edge_color='#dddddd', node_size=0, **kwargs ) plt.show()
1. For each term in the passed matrix score its KDE similarity with all other indexed terms.
def build(self, text, matrix, skim_depth=10, d_weights=False): """ 1. For each term in the passed matrix, score its KDE similarity with all other indexed terms. 2. With the ordered stack of similarities in hand, skim off the top X pairs and add them as edges. Args: ...
Gets a named section from the configuration source.
def get_settings(self, section=None, defaults=None): """ Gets a named section from the configuration source. :param section: a :class:`str` representing the section you want to retrieve from the configuration source. If ``None`` this will fallback to the :attr:`plaster.P...
Reads the configuration source and finds and loads a WSGI application defined by the entry with name name per the PasteDeploy configuration format and loading mechanism.
def get_wsgi_app(self, name=None, defaults=None): """ Reads the configuration source and finds and loads a WSGI application defined by the entry with name ``name`` per the PasteDeploy configuration format and loading mechanism. :param name: The named WSGI app to find, load and r...
Reads the configuration source and finds and loads a WSGI server defined by the server entry with the name name per the PasteDeploy configuration format and loading mechanism.
def get_wsgi_server(self, name=None, defaults=None): """ Reads the configuration source and finds and loads a WSGI server defined by the server entry with the name ``name`` per the PasteDeploy configuration format and loading mechanism. :param name: The named WSGI server to find...
Reads the configuration soruce and finds and loads a WSGI filter defined by the filter entry with the name name per the PasteDeploy configuration format and loading mechanism.
def get_wsgi_filter(self, name=None, defaults=None): """Reads the configuration soruce and finds and loads a WSGI filter defined by the filter entry with the name ``name`` per the PasteDeploy configuration format and loading mechanism. :param name: The named WSGI filter to find, load an...
Return an: class: collections. OrderedDict representing the application config for a WSGI application named name in the PasteDeploy config file specified by self. uri.
def get_wsgi_app_settings(self, name=None, defaults=None): """ Return an :class:`collections.OrderedDict` representing the application config for a WSGI application named ``name`` in the PasteDeploy config file specified by ``self.uri``. ``defaults``, if passed, should be a dict...
Set up logging via: func: logging. config. fileConfig.
def setup_logging(self, defaults=None): """ Set up logging via :func:`logging.config.fileConfig`. Defaults are specified for the special ``__file__`` and ``here`` variables, similar to PasteDeploy config loading. Extra defaults can optionally be specified as a dict in ``defaults...
Checks a name and determines whether to use the default name.
def _maybe_get_default_name(self, name): """Checks a name and determines whether to use the default name. :param name: The current name to check. :return: Either None or a :class:`str` representing the name. """ if name is None and self.uri.fragment: name = self.uri....
Set cursor position on the color corresponding to the hue value.
def set(self, hue): """Set cursor position on the color corresponding to the hue value.""" x = hue / 360. * self.winfo_width() self.coords('cursor', x, 0, x, self.winfo_height()) self._variable.set(hue)
Create an L { IService } for the database specified by the given configuration.
def makeService(cls, options): """ Create an L{IService} for the database specified by the given configuration. """ from axiom.store import Store jm = options['journal-mode'] if jm is not None: jm = jm.decode('ascii') store = Store(options['dbd...
Returns the names of everything ( books notes graphs etc. ) in the project.
def pageNames(matching=False,workbooks=True,graphs=True): """ Returns the names of everything (books, notes, graphs, etc.) in the project. Args: matching (str, optional): if given, only return names with this string in it workbooks (bool): if True, return workbooks graphs (bool): if...
Returns the type of the page with that name. If that name doesn t exist None is returned.
def getPageType(name,number=False): """Returns the type of the page with that name. If that name doesn't exist, None is returned. Args: name (str): name of the page to get the folder from number (bool): if True, return numbers (i.e., a graph will be 3) if False, return words whe...
Prints every page in the project to the console.
def listEverything(matching=False): """Prints every page in the project to the console. Args: matching (str, optional): if given, only return names with this string in it """ pages=pageNames() if matching: pages=[x for x in pages if matching in x] for i,page in enumerate(pages)...
return sheet names of a book.
def sheetNames(book=None): """return sheet names of a book. Args: book (str, optional): If a book is given, pull names from that book. Otherwise, try the active one Returns: list of sheet names (typical case). None if book has no sheets. False if book doesn't ex...
returns the pyorigin object for a sheet.
def getSheet(book=None,sheet=None): """returns the pyorigin object for a sheet.""" # figure out what book to use if book and not book.lower() in [x.lower() for x in bookNames()]: print("book %s doesn't exist"%book) return if book is None: book=activeBook().lower() if book is...
Delete a sheet from a book. If either isn t given use the active one.
def sheetDelete(book=None,sheet=None): """ Delete a sheet from a book. If either isn't given, use the active one. """ if book is None: book=activeBook() if sheet in sheetNames(): PyOrigin.WorksheetPages(book).Layers(sheetNames().index(sheet)).Destroy()
Delete all sheets which contain no data
def sheetDeleteEmpty(bookName=None): """Delete all sheets which contain no data""" if bookName is None: bookName = activeBook() if not bookName.lower() in [x.lower() for x in bookNames()]: print("can't clean up a book that doesn't exist:",bookName) return poBook=PyOrigin.Workshee...
return the contents of a pickle file
def pickle_load(fname): """return the contents of a pickle file""" assert type(fname) is str and os.path.exists(fname) print("loaded",fname) return pickle.load(open(fname,"rb"))
save something to a pickle file
def pickle_save(thing,fname=None): """save something to a pickle file""" if fname is None: fname=os.path.expanduser("~")+"/%d.pkl"%time.time() assert type(fname) is str and os.path.isdir(os.path.dirname(fname)) pickle.dump(thing, open(fname,"wb"),pickle.HIGHEST_PROTOCOL) print("saved",fname)
Put 2d numpy data into a temporary HTML file. This is a hack copy/ pasted from an earlier version of this software. It is very messy but works great! Good enough for me.
def sheetToHTML(sheet): """ Put 2d numpy data into a temporary HTML file. This is a hack, copy/pasted from an earlier version of this software. It is very messy, but works great! Good enough for me. """ assert "SHEET" in str(type(sheet)) #data,names=None,units=None,bookName=None,sheetName=N...
return a dict with the code for each function
def getCodeBlocks(): """return a dict with the code for each function""" raw=open("examples.py").read() d={} for block in raw.split("if __name__")[0].split("\ndef "): title=block.split("\n")[0].split("(")[0] if not title.startswith("demo_"): continue code=[x[4:] for x...
return a dict with the output of each function
def getOutputBlocks(): """return a dict with the output of each function""" raw=open("output.txt").read() d={} for block in raw.split("\n####### ")[1:]: title=block.split("\n")[0].split("(")[0] block=block.split("\n",1)[1].strip() d[title]=block.split("\nfinished in ")[0] ret...
Turn a byte string from the command line into a unicode string.
def decodeCommandLine(self, cmdline): """Turn a byte string from the command line into a unicode string. """ codec = getattr(sys.stdin, 'encoding', None) or sys.getdefaultencoding() return unicode(cmdline, codec)
Yield tokens.
def tokenize(text): """ Yield tokens. Args: text (str): The original text. Yields: dict: The next token. """ stem = PorterStemmer().stem tokens = re.finditer('[a-z]+', text.lower()) for offset, match in enumerate(tokens): # Get the raw token. unstemm...
Sort an ordered dictionary by value descending.
def sort_dict(d, desc=True): """ Sort an ordered dictionary by value, descending. Args: d (OrderedDict): An ordered dictionary. desc (bool): If true, sort desc. Returns: OrderedDict: The sorted dictionary. """ sort = sorted(d.items(), key=lambda x: x[1], reverse=desc)...
Yield a sliding window over an iterable.
def window(seq, n=2): """ Yield a sliding window over an iterable. Args: seq (iter): The sequence. n (int): The window width. Yields: tuple: The next window. """ it = iter(seq) result = tuple(islice(it, n)) if len(result) == n: yield result for t...
Move the SubStore at the indicated location into the given site store s directory and then hook it up to the site store s authentication database.
def insertUserStore(siteStore, userStorePath): """ Move the SubStore at the indicated location into the given site store's directory and then hook it up to the site store's authentication database. @type siteStore: C{Store} @type userStorePath: C{FilePath} """ # The following may, but does ...
Move the SubStore for the given user account out of the given site store completely. Place the user store s database directory into the given destination directory.
def extractUserStore(userAccount, extractionDestination, legacySiteAuthoritative=True): """ Move the SubStore for the given user account out of the given site store completely. Place the user store's database directory into the given destination directory. @type userAccount: C{LoginAccount} @t...
Retrieve L { LoginMethod } items from store C { store } optionally constraining them by protocol
def getLoginMethods(store, protocol=None): """ Retrieve L{LoginMethod} items from store C{store}, optionally constraining them by protocol """ if protocol is not None: comp = OR(LoginMethod.protocol == u'*', LoginMethod.protocol == protocol) else: comp = None ...
Retrieve account name information about the given database.
def getAccountNames(store, protocol=None): """ Retrieve account name information about the given database. @param store: An Axiom Store representing a user account. It must have been opened through the store which contains its account information. @return: A generator of two-tuples of (userna...