text
stringlengths
81
112k
Returns the location of the :py:mod:`everest` data on disk for a given target. :param ID: The target ID :param int season: The target season number :param bool relative: Relative path? Default :py:obj:`False` def TargetDirectory(ID, season, relative=False, **kwargs): ''' Returns the location o...
Returns the name of the DVS PDF for a given target. :param ID: The target ID :param int season: The target season number :param str cadence: The cadence type. Default `lc` def DVSFile(ID, season, cadence='lc'): ''' Returns the name of the DVS PDF for a given target. :param ID: The target ID ...
Returns the design matrix of CBVs for the given target. :param model: An instance of the :py:obj:`everest` model for the target def GetTargetCBVs(model): ''' Returns the design matrix of CBVs for the given target. :param model: An instance of the :py:obj:`everest` model for the target ''' #...
Fits the CBV design matrix to the de-trended flux of a given target. This is called internally whenever the user accesses the :py:attr:`fcor` attribute. :param model: An instance of the :py:obj:`everest` model for the target def FitCBVs(model): ''' Fits the CBV design matrix to the de-trended flux...
Generate the CSV file used in the search database for the documentation. def StatsToCSV(campaign, model='nPLD'): ''' Generate the CSV file used in the search database for the documentation. ''' statsfile = os.path.join(EVEREST_SRC, 'missions', 'k2', 'tables', 'c%02d_%s.cdpp...
Remove ``item`` for the :class:`zset` it it exists. If found it returns the score of the item removed. def remove(self, item): '''Remove ``item`` for the :class:`zset` it it exists. If found it returns the score of the item removed.''' score = self._dict.pop(item, None) if score is not Non...
Return a tuple of ordered fields for this :class:`ColumnTS`. def fields(self): '''Return a tuple of ordered fields for this :class:`ColumnTS`.''' key = self.id + ':fields' encoding = self.client.encoding return tuple(sorted((f.decode(encoding) for f in ...
Handle any pending relations to the sending model. Sent from class_prepared. def do_pending_lookups(event, sender, **kwargs): """Handle any pending relations to the sending model. Sent from class_prepared.""" key = (sender._meta.app_label, sender._meta.name) for callback in pending_lookups.pop(key, []...
Create a Many2Many through model with two foreign key fields and a CompositeFieldId depending on the two foreign keys. def Many2ManyThroughModel(field): '''Create a Many2Many through model with two foreign key fields and a CompositeFieldId depending on the two foreign keys.''' from stdnet.odm import ModelT...
formodel is the model which the manager . def makeMany2ManyRelatedManager(formodel, name_relmodel, name_formodel): '''formodel is the model which the manager .''' class _Many2ManyRelatedManager(Many2ManyRelatedManager): pass _Many2ManyRelatedManager.formodel = formodel _Many2ManyRelate...
Override :meth:`Manager.session` so that this :class:`RelatedManager` can retrieve the session from the :attr:`related_instance` if available. def session(self, session=None): '''Override :meth:`Manager.session` so that this :class:`RelatedManager` can retrieve the session from the ...
Add ``value``, an instance of :attr:`formodel` to the :attr:`through` model. This method can only be accessed by an instance of the model for which this related manager is an attribute. def add(self, value, session=None, **kwargs): '''Add ``value``, an instance of :attr:`formodel` to the :attr:`through` mo...
Remove *value*, an instance of ``self.model`` from the set of elements contained by the field. def remove(self, value, session=None): '''Remove *value*, an instance of ``self.model`` from the set of elements contained by the field.''' s, instance = self.session_instance('remove', value, session) ...
Double metaphone word processor. def metaphone_processor(words): '''Double metaphone word processor.''' for word in words: for w in double_metaphone(word): if w: w = w.strip() if w: yield w
Double metaphone word processor slightly modified so that when no words are returned by the algorithm, the original word is returned. def tolerant_metaphone_processor(words): '''Double metaphone word processor slightly modified so that when no words are returned by the algorithm, the original word is returned.''' ...
Porter Stemmer word processor def stemming_processor(words): '''Porter Stemmer word processor''' stem = PorterStemmer().stem for word in words: word = stem(word, 0, len(word)-1) yield word
Chooses between the different pools. If ``pool == 'AnyPool'``, chooses based on availability. def Pool(pool='AnyPool', **kwargs): ''' Chooses between the different pools. If ``pool == 'AnyPool'``, chooses based on availability. ''' if pool == 'MPIPool': return MPIPool(**kwargs) el...
If this isn't the master process, wait for instructions. def wait(self): """ If this isn't the master process, wait for instructions. """ if self.is_master(): raise RuntimeError("Master node told to await jobs.") status = MPI.Status() while True: ...
Like the built-in :py:func:`map` function, apply a function to all of the values in a list and return the list of results. :param function: The function to apply to the list. :param tasks: The list of elements. def map(self, function, tasks): """ Like t...
Just send a message off to all the pool members which contains the special :class:`_close_pool_message` sentinel. def close(self): """ Just send a message off to all the pool members which contains the special :class:`_close_pool_message` sentinel. """ if self.is_master...
Decorator for committing changes when the instance session is not in a transaction. def commit_when_no_transaction(f): '''Decorator for committing changes when the instance session is not in a transaction.''' def _(self, *args, **kwargs): r = f(self, *args, **kwargs) return self.session.a...
Returns the :class:`stdnet.BackendStructure`. def backend(self): '''Returns the :class:`stdnet.BackendStructure`. ''' session = self.session if session is not None: if self._field: return session.model(self._field.model).backend else: ...
Returns the :class:`stdnet.BackendStructure`. def read_backend(self): '''Returns the :class:`stdnet.BackendStructure`. ''' session = self.session if session is not None: if self._field: return session.model(self._field.model).read_backend e...
Number of elements in the :class:`Structure`. def size(self): '''Number of elements in the :class:`Structure`.''' if self.cache.cache is None: return self.read_backend_structure().size() else: return len(self.cache.cache)
Load ``data`` from the :class:`stdnet.BackendDataServer`. def load_data(self, data, callback=None): '''Load ``data`` from the :class:`stdnet.BackendDataServer`.''' return self.backend.execute( self.value_pickler.load_iterable(data, self.session), callback)
Iteratir over values of :class:`PairMixin`. def values(self): '''Iteratir over values of :class:`PairMixin`.''' if self.cache.cache is None: backend = self.read_backend return backend.execute(backend.structure(self).values(), self.load_val...
Add a *pair* to the structure. def pair(self, pair): '''Add a *pair* to the structure.''' if len(pair) == 1: # if only one value is passed, the value must implement a # score function which retrieve the first value of the pair # (score in zset, timevalue in time...
Remove *keys* from the key-value container. def remove(self, *keys): '''Remove *keys* from the key-value container.''' dumps = self.pickler.dumps self.cache.remove([dumps(v) for v in keys])
Count the number of elements bewteen *start* and *stop*. def count(self, start, stop): '''Count the number of elements bewteen *start* and *stop*.''' s1 = self.pickler.dumps(start) s2 = self.pickler.dumps(stop) return self.backend_structure().count(s1, s2)
Return the range by rank between start and end. def irange(self, start=0, end=-1, callback=None, withscores=True, **options): '''Return the range by rank between start and end.''' backend = self.read_backend res = backend.structure(self).irange(start, end, ...
pop a range by score from the :class:`OrderedMixin` def pop_range(self, start, stop, callback=None, withscores=True): '''pop a range by score from the :class:`OrderedMixin`''' s1 = self.pickler.dumps(start) s2 = self.pickler.dumps(stop) backend = self.backend res = backend....
pop a range from the :class:`OrderedMixin` def ipop_range(self, start=0, stop=-1, callback=None, withscores=True): '''pop a range from the :class:`OrderedMixin`''' backend = self.backend res = backend.structure(self).ipop_range(start, stop, w...
Appends a copy of *value* at the end of the :class:`Sequence`. def push_back(self, value): '''Appends a copy of *value* at the end of the :class:`Sequence`.''' self.cache.push_back(self.value_pickler.dumps(value)) return self
Remove the last element from the :class:`Sequence`. def pop_back(self): '''Remove the last element from the :class:`Sequence`.''' backend = self.backend return backend.execute(backend.structure(self).pop_back(), self.value_pickler.loads)
Add *value* to the set def add(self, value): '''Add *value* to the set''' return self.cache.update((self.value_pickler.dumps(value),))
Add iterable *values* to the set def update(self, values): '''Add iterable *values* to the set''' d = self.value_pickler.dumps return self.cache.update(tuple((d(v) for v in values)))
Remove an element *value* from a set if it is a member. def discard(self, value): '''Remove an element *value* from a set if it is a member.''' return self.cache.remove((self.value_pickler.dumps(value),))
Remove an iterable of *values* from the set. def difference_update(self, values): '''Remove an iterable of *values* from the set.''' d = self.value_pickler.dumps return self.cache.remove(tuple((d(v) for v in values)))
Remove the first element from of the list. def pop_front(self): '''Remove the first element from of the list.''' backend = self.backend return backend.execute(backend.structure(self).pop_front(), self.value_pickler.loads)
Remove the last element from of the list. If no elements are available, blocks for at least ``timeout`` seconds. def block_pop_back(self, timeout=10): '''Remove the last element from of the list. If no elements are available, blocks for at least ``timeout`` seconds.''' value = yield self.backend_st...
Remove the first element from of the list. If no elements are available, blocks for at least ``timeout`` seconds. def block_pop_front(self, timeout=10): '''Remove the first element from of the list. If no elements are available, blocks for at least ``timeout`` seconds.''' value = yield self.backend...
Appends a copy of ``value`` to the beginning of the list. def push_front(self, value): '''Appends a copy of ``value`` to the beginning of the list.''' self.cache.push_front(self.value_pickler.dumps(value))
The rank of a given *value*. This is the position of *value* in the :class:`OrderedMixin` container. def rank(self, value): '''The rank of a given *value*. This is the position of *value* in the :class:`OrderedMixin` container.''' value = self.value_pickler.dumps(value) return self.backend...
The rank of a given *dte* in the timeseries def rank(self, dte): '''The rank of a given *dte* in the timeseries''' timestamp = self.pickler.dumps(dte) return self.backend_structure().rank(timestamp)
Pop a value at *index* from the :class:`TS`. Return ``None`` if index is not out of bound. def ipop(self, index): '''Pop a value at *index* from the :class:`TS`. Return ``None`` if index is not out of bound.''' backend = self.backend res = backend.structure(self).ipop(index) retur...
The times between times *start* and *stop*. def times(self, start, stop, callback=None, **kwargs): '''The times between times *start* and *stop*.''' s1 = self.pickler.dumps(start) s2 = self.pickler.dumps(stop) backend = self.read_backend res = backend.structure(self).times(...
The times between rank *start* and *stop*. def itimes(self, start=0, stop=-1, callback=None, **kwargs): '''The times between rank *start* and *stop*.''' backend = self.read_backend res = backend.structure(self).itimes(start, stop, **kwargs) return backend.execute(res, callback or se...
A :class:`Q` performs a series of operations and ultimately generate of set of matched elements ``ids``. If on the other hand, a different field is required, it can be specified with the :meth:`get_field` method. For example, lets say a model has a field called ``object_id`` which contains ids of another model, we ...
Create a new :class:`Query` with additional clauses corresponding to ``where`` or ``limit`` in a ``SQL SELECT`` statement. :parameter kwargs: dictionary of limiting clauses. :rtype: a new :class:`Query` instance. For example:: qs = session.query(MyModel) result = qs.filter(group = 'planet') def fil...
Returns a new :class:`Query` with additional clauses corresponding to ``EXCEPT`` in a ``SQL SELECT`` statement. :parameter kwargs: dictionary of limiting clauses. :rtype: a new :class:`Query` instance. Using an equivalent example to the :meth:`filter` method:: qs = session.query(MyModel) result1 = q...
Return a new :class:`Query` obtained form the union of this :class:`Query` with one or more *queries*. For example, lets say we want to have the union of two queries obtained from the :meth:`filter` method:: query = session.query(MyModel) qs = query.filter(field1 = 'bla').union(query.filter(field2 = 'foo...
Return a new :class:`Query` obtained form the intersection of this :class:`Query` with one or more *queries*. Workds the same way as the :meth:`union` method. def intersect(self, *queries): '''Return a new :class:`Query` obtained form the intersection of this :class:`Query` with one or more *queries*. Work...
Sort the query by the given field :parameter ordering: a string indicating the class:`Field` name to sort by. If prefixed with ``-``, the sorting will be in descending order, otherwise in ascending order. :return type: a new :class:`Query` instance. def sort_by(self, ordering): '''Sort the query...
Search *text* in model. A search engine needs to be installed for this function to be available. :parameter text: a string to search. :return type: a new :class:`Query` instance. def search(self, text, lookup=None): '''Search *text* in model. A search engine needs to be installed for this function to be...
For :ref:`backend <db-index>` supporting scripting, it is possible to construct complex queries which execute the scripting *code* against each element in the query. The *coe* should reference an instance of :attr:`model` by ``this`` keyword. :parameter code: a valid expression in the scripting language of the da...
Return a new :class:`QueryElem` for *q* applying a text search. def search_queries(self, q): '''Return a new :class:`QueryElem` for *q* applying a text search.''' if self.text: searchengine = self.session.router.search_engine if searchengine: return searchen...
It returns a new :class:`Query` that automatically follows the foreign-key relationship ``related``. :parameter related: A field name corresponding to a :class:`ForeignKey` in :attr:`Query.model`. :parameter related_fields: optional :class:`Field` names for the ``related`` model to load. If not provided,...
This is provides a :ref:`performance boost <increase-performance>` in cases when you need to load a subset of fields of your model. The boost achieved is less than the one obtained when using :meth:`Query.load_related`, since it does not reduce the number of requests to the database. However, it can save you lots o...
Works like :meth:`load_only` to provides a :ref:`performance boost <increase-performance>` in cases when you need to load all fields except a subset specified by *fields*. def dont_load(self, *fields): '''Works like :meth:`load_only` to provides a :ref:`performance boost <increase-performance>` in cases wh...
Return an instance of a model matching the query. A special case is the query on ``id`` which provides a direct access to the :attr:`session` instances. If the given primary key is present in the session, the object is returned directly without performing any query. def get(self, **kwargs): '''Return an in...
Build the :class:`QueryElement` representing this query. def construct(self): '''Build the :class:`QueryElement` representing this query.''' if self.__construct is None: self.__construct = self._construct() return self.__construct
Build and return the :class:`stdnet.utils.async.BackendQuery`. This is a lazy method in the sense that it is evaluated once only and its result stored for future retrieval. def backend_query(self, **kwargs): '''Build and return the :class:`stdnet.utils.async.BackendQuery`. This is a lazy method in the sens...
Aggregate lookup parameters. def aggregate(self, kwargs): '''Aggregate lookup parameters.''' meta = self._meta fields = meta.dfields field_lookups = {} for name, value in iteritems(kwargs): bits = name.split(JSPLITTER) field_name = bits.pop(0) ...
Generator of all model in model. def models_from_model(model, include_related=False, exclude=None): '''Generator of all model in model.''' if exclude is None: exclude = set() if model and model not in exclude: exclude.add(model) if isinstance(model, ModelType) and not model._meta.ab...
A generator of :class:`StdModel` classes found in *application*. :parameter application: A python dotted path or an iterable over python dotted-paths where models are defined. Only models defined in these paths are considered. For example:: from stdnet.odm import model_iterator APPS = ('stdnet.contrib....
Set the search ``engine`` for this :class:`Router`. def set_search_engine(self, engine): '''Set the search ``engine`` for this :class:`Router`.''' self._search_engine = engine self._search_engine.set_router(self)
Register a :class:`Model` with this :class:`Router`. If the model was already registered it does nothing. :param model: a :class:`Model` class. :param backend: a :class:`stdnet.BackendDataServer` or a :ref:`connection string <connection-string>`. :param read_backend: Optional :class:`stdnet.BackendDataServer` for ...
Retrieve a :class:`Model` from its universally unique identifier ``uuid``. If the ``uuid`` does not match any instance an exception will raise. def from_uuid(self, uuid, session=None): '''Retrieve a :class:`Model` from its universally unique identifier ``uuid``. If the ``uuid`` does not match any instance an e...
Flush :attr:`registered_models`. :param exclude: optional list of model names to exclude. :param include: optional list of model names to include. :param dryrun: Doesn't remove anything, simply collect managers to flush. :return: def flush(self, exclude=None, include=None, ...
Unregister a ``model`` if provided, otherwise it unregister all registered models. Return a list of unregistered model managers or ``None`` if no managers were removed. def unregister(self, model=None): '''Unregister a ``model`` if provided, otherwise it unregister all registered models. Return a list of unreg...
A higher level registration functions for group of models located on application modules. It uses the :func:`model_iterator` function to iterate through all :class:`Model` models available in ``applications`` and register them using the :func:`register` low level method. :parameter applications: A String or a list of ...
Execute a script. makes sure all required scripts are loaded. def execute_script(self, name, keys, *args, **options): '''Execute a script. makes sure all required scripts are loaded. ''' script = get_script(name) if not script: raise redis.RedisError('No su...
Register a :class:`StdModel` with this search :class:`SearchEngine`. When registering a model, every time an instance is created, it will be indexed by the search engine. :param model: a :class:`StdModel` class. :param related: a list of related fields to include in the index. def register(self, model, related=N...
Generator of indexable words in *text*. This functions loop through the :attr:`word_middleware` attribute to process the text. :param text: string from which to extract words. :param for_search: flag indicating if the the words will be used for search or to index the database. This flug is used in conjunctio...
Add a *middleware* function to the list of :attr:`word_middleware`, for preprocessing words to be indexed. :param middleware: a callable receving an iterable over words. :param for_search: flag indicating if the *middleware* can be used for the text to search. Default: ``True``. def add_word_middleware(self,...
Return a query for ``model`` when it needs to be indexed. def query(self, model): '''Return a query for ``model`` when it needs to be indexed. ''' session = self.router.session() fields = tuple((f.name for f in model._meta.scalarfields if f.type == 'text')) ...
Returns a PEP 386-compliant version number from *version*. def get_version(version): "Returns a PEP 386-compliant version number from *version*." assert len(version) == 5 assert version[3] in ('alpha', 'beta', 'rc', 'final') parts = 2 if version[2] == 0 else 3 main = '.'.join(map(str, version[...
Returns the value of the planet radius over the stellar radius for a given depth :py:obj:`d`, given the :py:class:`everest.pysyzygy` transit :py:obj:`kwargs`. def Get_RpRs(d, **kwargs): ''' Returns the value of the planet radius over the stellar radius for a given depth :py:obj:`d`, given the :...
Returns the value of the stellar density for a given transit duration :py:obj:`dur`, given the :py:class:`everest.pysyzygy` transit :py:obj:`kwargs`. def Get_rhos(dur, **kwargs): ''' Returns the value of the stellar density for a given transit duration :py:obj:`dur`, given the :py:class:`everes...
A `Mandel-Agol <http://adsabs.harvard.edu/abs/2002ApJ...580L.171M>`_ transit model, but with the depth and the duration as primary input variables. :param numpy.ndarray time: The time array :param float t0: The time of first transit in units of \ :py:obj:`BJD` - 2454833. :param float dur...
Given a ``startdate`` and an ``enddate`` dates, evaluate the date intervals from which data is not available. It return a list of two-dimensional tuples containing start and end date for the interval. The list could contain 0, 1 or 2 tuples. def intervals(self, startdate, enddate, parseinter...
Return the front pair of the structure def front(self, *fields): '''Return the front pair of the structure''' v, f = tuple(self.irange(0, 0, fields=fields)) if v: return (v[0], dict(((field, f[field][0]) for field in f)))
Perform a multivariate statistic calculation of this :class:`ColumnTS` from *start* to *end*. :param start: Optional index (rank) where to start the analysis. :param end: Optional index (rank) where to end the analysis. :param fields: Optional subset of :meth:`fields` to perform analysis on. If not provided ...
Perform a multivariate statistic calculation of this :class:`ColumnTS` from a *start* date/datetime to an *end* date/datetime. :param start: Start date for analysis. :param end: End date for analysis. :param fields: Optional subset of :meth:`fields` to perform analysis on. If not provided all fields are in...
Perform cross multivariate statistics calculation of this :class:`ColumnTS` and other optional *series* from *start* to *end*. :parameter start: the start rank. :parameter start: the end rank :parameter field: name of field to perform multivariate statistics. :parameter series: a list of two elements tuple cont...
Merge this :class:`ColumnTS` with several other *series*. :parameters series: a list of tuples where the nth element is a tuple of the form:: (wight_n, ts_n1, ts_n2, ..., ts_nMn) The result will be calculated using the formula:: ts = weight_1*ts_11*ts_12*...*ts_1M1 + weight_2*ts_21*ts_22*...*ts...
Merge ``series`` and return the results without storing data in the backend server. def merged_series(cls, *series, **kwargs): '''Merge ``series`` and return the results without storing data in the backend server.''' router, backend = cls.check_router(None, *series) if backend: ...
Return the 0-based index (rank) of ``score``. If the score is not available it returns a negative integer which absolute score is the left most closest index with score less than *score*. def rank(self, score): '''Return the 0-based index (rank) of ``score``. If the score is not available it returns a negative...
Create a new instance of :attr:`model` from a *state* tuple. def make_object(self, state=None, backend=None): '''Create a new instance of :attr:`model` from a *state* tuple.''' model = self.model obj = model.__new__(model) self.load_state(obj, state, backend) return obj
Perform validation for *instance* and stores serialized data, indexes and errors into local cache. Return ``True`` if the instance is ready to be saved to database. def is_valid(self, instance): '''Perform validation for *instance* and stores serialized data, indexes and errors into local cache. Return ``...
Return a two elements tuple containing a list of fields names and a list of field attribute names. def backend_fields(self, fields): '''Return a two elements tuple containing a list of fields names and a list of field attribute names.''' dfields = self.dfields processed = set() na...
Model metadata in a dictionary def as_dict(self): '''Model metadata in a dictionary''' pk = self.pk id_type = 3 if pk.type == 'auto': id_type = 1 return {'id_name': pk.name, 'id_type': id_type, 'sorted': bool(self.ordering), ...
Return the current :class:`ModelState` for this :class:`Model`. If ``kwargs`` parameters are passed a new :class:`ModelState` is created, otherwise it returns the cached value. def get_state(self, **kwargs): '''Return the current :class:`ModelState` for this :class:`Model`. If ``kwargs`` parameters are pas...
Universally unique identifier for an instance of a :class:`Model`. def uuid(self): '''Universally unique identifier for an instance of a :class:`Model`. ''' pk = self.pkvalue() if not pk: raise self.DoesNotExist( 'Object not saved. Cannot obtain univers...
The :class:`stdnet.BackendDatServer` for this instance. It can be ``None``. def backend(self, client=None): '''The :class:`stdnet.BackendDatServer` for this instance. It can be ``None``. ''' session = self.session if session: return session.model(s...
The read :class:`stdnet.BackendDatServer` for this instance. It can be ``None``. def read_backend(self, client=None): '''The read :class:`stdnet.BackendDatServer` for this instance. It can be ``None``. ''' session = self.session if session: return ...
Create a :class:`Model` class for objects requiring and interface similar to :class:`StdModel`. We refers to this type of models as :ref:`local models <local-models>` since instances of such models are not persistent on a :class:`stdnet.BackendDataServer`. :param name: Name of the model class. :param attributes: posit...
Generator of fields loaded from database def loadedfields(self): '''Generator of fields loaded from database''' if self._loadedfields is None: for field in self._meta.scalarfields: yield field else: fields = self._meta.dfields processed = set(...
Generator of fields,values pairs. Fields correspond to the ones which have been loaded (usually all of them) or not loaded but modified. Check the :ref:`load_only <performance-loadonly>` query function for more details. If *exclude_cache* evaluates to ``True``, fields with :attr:`Field.as_cache` attribute set to ``Tru...
Set cache fields to ``None``. Check :attr:`Field.as_cache` for information regarding fields which are considered cache. def clear_cache_fields(self): '''Set cache fields to ``None``. Check :attr:`Field.as_cache` for information regarding fields which are considered cache.''' for field in self._meta.sca...