INSTRUCTION stringlengths 1 8.43k | RESPONSE stringlengths 75 104k |
|---|---|
The list of compiler extensions. Example:: | def compiler_extensions(self):
"""The list of compiler extensions.
Example::
>>> attrs = AssetAttributes(environment, 'js/lib/external.min.js.coffee')
>>> attrs.compiler_extensions
['.coffee']
"""
try:
index = self.extensions.index(self.fo... |
The list of compilers used to build asset. | def compilers(self):
"""The list of compilers used to build asset."""
return [self.environment.compilers.get(e) for e in self.compiler_extensions] |
The list of all processors ( preprocessors compilers postprocessors ) used to build asset. | def processors(self):
"""The list of all processors (preprocessors, compilers,
postprocessors) used to build asset.
"""
return self.preprocessors + list(reversed(self.compilers)) + self.postprocessors |
MIME type of the asset. | def mimetype(self):
"""MIME type of the asset."""
return (self.environment.mimetypes.get(self.format_extension) or
self.compiler_mimetype or 'application/octet-stream') |
Implicit MIME type of the asset by its compilers. | def compiler_mimetype(self):
"""Implicit MIME type of the asset by its compilers."""
for compiler in reversed(self.compilers):
if compiler.result_mimetype:
return compiler.result_mimetype
return None |
Implicit format extension on the asset by its compilers. | def compiler_format_extension(self):
"""Implicit format extension on the asset by its compilers."""
for extension, mimetype in self.environment.mimetypes.items():
if mimetype == self.compiler_mimetype:
return extension
return None |
Register passed processor for passed mimetype. | def register(self, mimetype, processor):
"""Register passed `processor` for passed `mimetype`."""
if mimetype not in self or processor not in self[mimetype]:
self.setdefault(mimetype, []).append(processor) |
Remove passed processor for passed mimetype. If processor for this MIME type does not found in the registry nothing happens. | def unregister(self, mimetype, processor):
"""Remove passed `processor` for passed `mimetype`. If processor for
this MIME type does not found in the registry, nothing happens.
"""
if mimetype in self and processor in self[mimetype]:
self[mimetype].remove(processor) |
Register: class: ~gears. processors. DirectivesProcessor as a preprocessor for text/ css and application/ javascript MIME types. | def register_defaults(self):
"""Register :class:`~gears.processors.DirectivesProcessor` as
a preprocessor for `text/css` and `application/javascript` MIME types.
"""
self.register('text/css', DirectivesProcessor.as_handler())
self.register('application/javascript', DirectivesProc... |
The registry for supported suffixes of assets. It is built from MIME types and compilers registries and is cached at the first call. See: class: ~gears. environment. Suffixes for more information. | def suffixes(self):
"""The registry for supported suffixes of assets. It is built from
MIME types and compilers registries, and is cached at the first call.
See :class:`~gears.environment.Suffixes` for more information.
"""
if not hasattr(self, '_suffixes'):
suffixes ... |
The list of search paths. It is built from registered finders which has paths property. Can be useful for compilers to resolve internal dependencies. | def paths(self):
"""The list of search paths. It is built from registered finders, which
has ``paths`` property. Can be useful for compilers to resolve internal
dependencies.
"""
if not hasattr(self, '_paths'):
paths = []
for finder in self.finders:
... |
Register default compilers preprocessors and MIME types. | def register_defaults(self):
"""Register default compilers, preprocessors and MIME types."""
self.mimetypes.register_defaults()
self.preprocessors.register_defaults()
self.postprocessors.register_defaults() |
Allow Gears plugins to inject themselves to the environment. For example if your plugin s package contains such entry_points definition in setup. py gears_plugin. register function will be called with current environment during register_entry_points call:: | def register_entry_points(self, exclude=()):
"""Allow Gears plugins to inject themselves to the environment. For
example, if your plugin's package contains such ``entry_points``
definition in ``setup.py``, ``gears_plugin.register`` function will be
called with current environment during ... |
Find files using: attr: finders registry. The item parameter can be an instance of: class: ~gears. asset_attributes. AssetAttributes class a path to the asset or a logical path to the asset. If item is a logical path logical parameter must be set to True. | def find(self, item, logical=False):
"""Find files using :attr:`finders` registry. The ``item`` parameter
can be an instance of :class:`~gears.asset_attributes.AssetAttributes`
class, a path to the asset or a logical path to the asset. If ``item``
is a logical path, `logical` parameter m... |
Yield two - tuples for all files found in the directory given by path parameter. Result can be filtered by the second parameter mimetype that must be a MIME type of assets compiled source code. Each tuple has: class: ~gears. asset_attributes. AssetAttributes instance for found file path as first item and absolute path ... | def list(self, path, mimetype=None):
"""Yield two-tuples for all files found in the directory given by
``path`` parameter. Result can be filtered by the second parameter,
``mimetype``, that must be a MIME type of assets compiled source code.
Each tuple has :class:`~gears.asset_attributes... |
Save handled public assets to: attr: root directory. | def save(self):
"""Save handled public assets to :attr:`root` directory."""
for asset_attributes, absolute_path in self.list('**'):
logical_path = os.path.normpath(asset_attributes.logical_path)
check_asset = build_asset(self, logical_path, check=True)
if check_asset.... |
+ ----------------------------------------------------------------------- + | + --- splitter ------------------------------------------------------ + | | | + -- list widget -------------- + + - IdaSettingsView ------------- + | | | | | | | | | | | | | - plugin name | | | | | | | | - plugin name | | | | | | | | - plugin... | def PopulateForm(self):
"""
+-----------------------------------------------------------------------+
| +--- splitter ------------------------------------------------------+ |
| | +-- list widget--------------+ +- IdaSettingsView -------------+ | |
| | | ... |
Converts the class into an actual handler function that can be used when registering different types of processors in: class: ~gears. environment. Environment class instance. | def as_handler(cls, **initkwargs):
"""Converts the class into an actual handler function that can be used
when registering different types of processors in
:class:`~gears.environment.Environment` class instance.
The arguments passed to :meth:`as_handler` are forwarded to the
con... |
Runs: attr: executable with input as stdin.: class: AssetHandlerError exception is raised if execution is failed otherwise stdout is returned. | def run(self, input):
"""Runs :attr:`executable` with ``input`` as stdin.
:class:`AssetHandlerError` exception is raised, if execution is failed,
otherwise stdout is returned.
"""
p = self.get_process()
output, errors = p.communicate(input=input.encode('utf-8'))
i... |
Returns: class: subprocess. Popen instance with args from: meth: get_args result and piped stdin stdout and stderr. | def get_process(self):
"""Returns :class:`subprocess.Popen` instance with args from
:meth:`get_args` result and piped stdin, stdout and stderr.
"""
return Popen(self.get_args(), stdin=PIPE, stdout=PIPE, stderr=PIPE) |
This nasty piece of code is here to force the loading of IDA s Qt bindings. Without it Python attempts to load PySide from the site - packages directory and failing as it does not play nicely with IDA. | def import_qtcore():
"""
This nasty piece of code is here to force the loading of IDA's
Qt bindings.
Without it, Python attempts to load PySide from the site-packages
directory, and failing, as it does not play nicely with IDA.
via: github.com/tmr232/Cute
"""
has_ida = False
try:
... |
Get the netnode used to store settings metadata in the current IDB. Note that this implicitly uses the open IDB via the idc iterface. | def get_meta_netnode():
"""
Get the netnode used to store settings metadata in the current IDB.
Note that this implicitly uses the open IDB via the idc iterface.
"""
node_name = "$ {org:s}.{application:s}".format(
org=IDA_SETTINGS_ORGANIZATION,
application=IDA_SETTINGS_APPLICATION)
... |
Add the given plugin name to the list of plugin names registered in the current IDB. Note that this implicitly uses the open IDB via the idc iterface. | def add_netnode_plugin_name(plugin_name):
"""
Add the given plugin name to the list of plugin names registered in
the current IDB.
Note that this implicitly uses the open IDB via the idc iterface.
"""
current_names = set(get_netnode_plugin_names())
if plugin_name in current_names:
... |
Remove the given plugin name to the list of plugin names registered in the current IDB. Note that this implicitly uses the open IDB via the idc iterface. | def del_netnode_plugin_name(plugin_name):
"""
Remove the given plugin name to the list of plugin names registered in
the current IDB.
Note that this implicitly uses the open IDB via the idc iterface.
"""
current_names = set(get_netnode_plugin_names())
if plugin_name not in current_names:
... |
Import settings from the given file system path to given settings instance. | def import_settings(settings, config_path):
"""
Import settings from the given file system path to given settings instance.
type settings: IDASettingsInterface
type config_path: str
"""
other = QtCore.QSettings(config_path, QtCore.QSettings.IniFormat)
for k in other.allKeys():
setti... |
Export the given settings instance to the given file system path. | def export_settings(settings, config_path):
"""
Export the given settings instance to the given file system path.
type settings: IDASettingsInterface
type config_path: str
"""
other = QtCore.QSettings(config_path, QtCore.QSettings.IniFormat)
for k, v in settings.iteritems():
other.s... |
Fetch the IDASettings instance for the curren plugin with directory scope. | def directory(self):
"""
Fetch the IDASettings instance for the curren plugin with directory scope.
rtype: IDASettingsInterface
"""
if self._config_directory is None:
ensure_ida_loaded()
return DirectoryIDASettings(self._plugin_name, directory=self._config_di... |
Fetch the settings value with the highest precedence for the given key or raise KeyError. Precedence: - IDB scope - directory scope - user scope - system scope | def get_value(self, key):
"""
Fetch the settings value with the highest precedence for the given
key, or raise KeyError.
Precedence:
- IDB scope
- directory scope
- user scope
- system scope
type key: basestring
rtype value: Union... |
Enumerate the keys found at any scope for the current plugin. | def iterkeys(self):
"""
Enumerate the keys found at any scope for the current plugin.
rtype: Generator[str]
"""
visited_keys = set()
try:
for key in self.idb.iterkeys():
if key not in visited_keys:
yield key
... |
Get the names of all plugins at the directory scope. Provide a config directory path to use this method outside of IDA. As this is a static method you can call the directly on IDASettings: | def get_directory_plugin_names(config_directory=None):
"""
Get the names of all plugins at the directory scope.
Provide a config directory path to use this method outside of IDA.
As this is a static method, you can call the directly on IDASettings:
import ida_settings
... |
Returns the response that should be used for any given exception. | def simple_error_handler(exc, *args):
"""
Returns the response that should be used for any given exception.
By default we handle the REST framework `APIException`, and also
Django's builtin `Http404` and `PermissionDenied` exceptions.
Any unhandled exceptions may return `None`, which will cause a ... |
Returns a given table for the given user. | def table(name, auth=None, eager=True):
"""Returns a given table for the given user."""
auth = auth or []
dynamodb = boto.connect_dynamodb(*auth)
table = dynamodb.get_table(name)
return Table(table=table, eager=eager) |
Returns a list of tables for the given user. | def tables(auth=None, eager=True):
"""Returns a list of tables for the given user."""
auth = auth or []
dynamodb = boto.connect_dynamodb(*auth)
return [table(t, auth, eager=eager) for t in dynamodb.list_tables()] |
Fetch packages and summary from Crates. io | def fetch_items(self, category, **kwargs):
"""Fetch packages and summary from Crates.io
:param category: the category of items to fetch
:param kwargs: backend arguments
:returns: a generator of items
"""
from_date = kwargs['from_date']
if category == CATEGORY_C... |
Extracts the identifier from an item depending on its type. | def metadata_id(item):
"""Extracts the identifier from an item depending on its type."""
if Crates.metadata_category(item) == CATEGORY_CRATES:
return str(item['id'])
else:
ts = item['fetched_on']
ts = str_to_datetime(ts)
return str(ts.timestamp()) |
Extracts the update time from an item. | def metadata_updated_on(item):
"""Extracts the update time from an item.
Depending on the item, the timestamp is extracted from the
'updated_at' or 'fetched_on' fields.
This date is converted to UNIX timestamp format.
:param item: item generated by the backend
:returns... |
Init client | def _init_client(self, from_archive=False):
"""Init client"""
return CratesClient(self.sleep_time, self.archive, from_archive) |
Fetch summary | def __fetch_summary(self):
"""Fetch summary"""
raw_summary = self.client.summary()
summary = json.loads(raw_summary)
summary['fetched_on'] = str(datetime_utcnow())
yield summary |
Fetch crates | def __fetch_crates(self, from_date):
"""Fetch crates"""
from_date = datetime_to_utc(from_date)
crates_groups = self.client.crates()
for raw_crates in crates_groups:
crates = json.loads(raw_crates)
for crate_container in crates['crates']:
if st... |
Get crate team owner | def __fetch_crate_owner_team(self, crate_id):
"""Get crate team owner"""
raw_owner_team = self.client.crate_attribute(crate_id, 'owner_team')
owner_team = json.loads(raw_owner_team)
return owner_team |
Get crate user owners | def __fetch_crate_owner_user(self, crate_id):
"""Get crate user owners"""
raw_owner_user = self.client.crate_attribute(crate_id, 'owner_user')
owner_user = json.loads(raw_owner_user)
return owner_user |
Get crate versions data | def __fetch_crate_versions(self, crate_id):
"""Get crate versions data"""
raw_versions = self.client.crate_attribute(crate_id, "versions")
version_downloads = json.loads(raw_versions)
return version_downloads |
Get crate version downloads | def __fetch_crate_version_downloads(self, crate_id):
"""Get crate version downloads"""
raw_version_downloads = self.client.crate_attribute(crate_id, "downloads")
version_downloads = json.loads(raw_version_downloads)
return version_downloads |
Get crate data | def __fetch_crate_data(self, crate_id):
"""Get crate data"""
raw_crate = self.client.crate(crate_id)
crate = json.loads(raw_crate)
return crate['crate'] |
Get Crates. io summary | def summary(self):
"""Get Crates.io summary"""
path = urijoin(CRATES_API_URL, CATEGORY_SUMMARY)
raw_content = self.fetch(path)
return raw_content |
Get crates in alphabetical order | def crates(self, from_page=1):
"""Get crates in alphabetical order"""
path = urijoin(CRATES_API_URL, CATEGORY_CRATES)
raw_crates = self.__fetch_items(path, from_page)
return raw_crates |
Get a crate by its ID | def crate(self, crate_id):
"""Get a crate by its ID"""
path = urijoin(CRATES_API_URL, CATEGORY_CRATES, crate_id)
raw_crate = self.fetch(path)
return raw_crate |
Get crate attribute | def crate_attribute(self, crate_id, attribute):
"""Get crate attribute"""
path = urijoin(CRATES_API_URL, CATEGORY_CRATES, crate_id, attribute)
raw_attribute_data = self.fetch(path)
return raw_attribute_data |
Return the items from Crates. io API using pagination | def __fetch_items(self, path, page=1):
"""Return the items from Crates.io API using pagination"""
fetch_data = True
parsed_crates = 0
total_crates = 0
while fetch_data:
logger.debug("Fetching page: %i", page)
try:
payload = {'sort': 'alp... |
Return the textual content associated to the Response object | def fetch(self, url, payload=None):
"""Return the textual content associated to the Response object"""
response = super().fetch(url, payload=payload)
return response.text |
Fetch questions from the Kitsune url. | def fetch(self, category=CATEGORY_QUESTION, offset=DEFAULT_OFFSET):
"""Fetch questions from the Kitsune url.
:param category: the category of items to fetch
:offset: obtain questions after offset
:returns: a generator of questions
"""
if not offset:
offset = ... |
Fetch questions from the Kitsune url | def fetch_items(self, category, **kwargs):
"""Fetch questions from the Kitsune url
:param category: the category of items to fetch
:param kwargs: backend arguments
:returns: a generator of items
"""
offset = kwargs['offset']
logger.info("Looking for questions a... |
Init client | def _init_client(self, from_archive=False):
"""Init client"""
return KitsuneClient(self.url, self.archive, from_archive) |
Retrieve questions from older to newer updated starting offset | def get_questions(self, offset=None):
"""Retrieve questions from older to newer updated starting offset"""
page = KitsuneClient.FIRST_PAGE
if offset:
page += int(offset / KitsuneClient.ITEMS_PER_PAGE)
while True:
api_questions_url = urijoin(self.base_url, '/que... |
Retrieve all answers for a question from older to newer ( updated ) | def get_question_answers(self, question_id):
"""Retrieve all answers for a question from older to newer (updated)"""
page = KitsuneClient.FIRST_PAGE
while True:
api_answers_url = urijoin(self.base_url, '/answer') + '/'
params = {
"page": page,
... |
Return the textual content associated to the Response object | def fetch(self, url, params):
"""Return the textual content associated to the Response object"""
logger.debug("Kitsune client calls API: %s params: %s",
url, str(params))
response = super().fetch(url, payload=params)
return response.text |
Fetch items from the ReMo url. | def fetch(self, category=CATEGORY_EVENT, offset=REMO_DEFAULT_OFFSET):
"""Fetch items from the ReMo url.
The method retrieves, from a ReMo URL, the set of items
of the given `category`.
:param category: the category of items to fetch
:param offset: obtain items after offset
... |
Fetch items | def fetch_items(self, category, **kwargs):
"""Fetch items
:param category: the category of items to fetch
:param kwargs: backend arguments
:returns: a generator of items
"""
offset = kwargs['offset']
logger.info("Looking for events at url '%s' of %s category an... |
Extracts the update time from a ReMo item. | def metadata_updated_on(item):
"""Extracts the update time from a ReMo item.
The timestamp is extracted from 'end' field.
This date is converted to a perceval format using a float value.
:param item: item generated by the backend
:returns: a UNIX timestamp
"""
... |
Extracts the category from a ReMo item. | def metadata_category(item):
"""Extracts the category from a ReMo item.
This backend generates items types 'event', 'activity'
or 'user'. To guess the type of item, the code will look
for unique fields.
"""
if 'estimated_attendance' in item:
category = CATEGO... |
Init client | def _init_client(self, from_archive=False):
"""Init client"""
return ReMoClient(self.url, self.archive, from_archive) |
Retrieve all items for category using pagination | def get_items(self, category=CATEGORY_EVENT, offset=REMO_DEFAULT_OFFSET):
"""Retrieve all items for category using pagination """
more = True # There are more items to be processed
next_uri = None # URI for the next items page query
page = ReMoClient.FIRST_PAGE
page += int(off... |
The buffer list this instance operates on. | def buffer_list(self):
"""
The buffer list this instance operates on.
Only available in mode != AIOBLOCK_MODE_POLL.
Changes on a submitted transfer are not fully applied until its
next submission: kernel will still be using original buffer list.
"""
if self._ioc... |
IO priority for this instance. | def io_priority(self):
"""
IO priority for this instance.
"""
return (
self._iocb.aio_reqprio
if self._iocb.u.c.flags & libaio.IOCB_FLAG_IOPRIO else
None
) |
Cancels all pending IO blocks. Waits until all non - cancellable IO blocks finish. De - initialises AIO context. | def close(self):
"""
Cancels all pending IO blocks.
Waits until all non-cancellable IO blocks finish.
De-initialises AIO context.
"""
if self._ctx is not None:
# Note: same as io_destroy
self._io_queue_release(self._ctx)
del self._ctx |
Submits transfers. | def submit(self, block_list):
"""
Submits transfers.
block_list (list of AIOBlock)
The IO blocks to hand off to kernel.
Returns the number of successfully submitted blocks.
"""
# io_submit ioctl will only return an error for issues with the first
# t... |
Cancel an IO block. | def cancel(self, block):
"""
Cancel an IO block.
block (AIOBlock)
The IO block to cancel.
Returns cancelled block's event data (see getEvents), or None if the
kernel returned EINPROGRESS. In the latter case, event completion will
happen on a later getEvents ... |
Cancel all submitted IO blocks. | def cancelAll(self):
"""
Cancel all submitted IO blocks.
Blocks until all submitted transfers have been finalised.
Submitting more transfers or processing completion events while this
method is running produces undefined behaviour.
Returns the list of values returned by ... |
Returns a list of event data from submitted IO blocks. | def getEvents(self, min_nr=1, nr=None, timeout=None):
"""
Returns a list of event data from submitted IO blocks.
min_nr (int, None)
When timeout is None, minimum number of events to collect before
returning.
If None, waits for all submitted events.
nr... |
Fetch events from the MozillaClub URL. | def fetch(self, category=CATEGORY_EVENT):
"""Fetch events from the MozillaClub URL.
The method retrieves, from a MozillaClub URL, the
events. The data is a Google spreadsheet retrieved using
the feed API REST.
:param category: the category of items to fetch
:returns: a... |
Fetch events | def fetch_items(self, category, **kwargs):
"""Fetch events
:param category: the category of items to fetch
:param kwargs: backend arguments
:returns: a generator of items
"""
logger.info("Looking for events at url '%s'", self.url)
nevents = 0 # number of event... |
Init client | def _init_client(self, from_archive=False):
"""Init client"""
return MozillaClubClient(self.url, self.archive, from_archive) |
Retrieve all cells from the spreadsheet. | def get_cells(self):
"""Retrieve all cells from the spreadsheet."""
logger.info("Retrieving all cells spreadsheet data ...")
logger.debug("MozillaClub client calls API: %s", self.base_url)
raw_cells = self.fetch(self.base_url)
return raw_cells.text |
Parse the MozillaClub spreadsheet feed cells json. | def parse(self):
"""Parse the MozillaClub spreadsheet feed cells json."""
nevents_wrong = 0
feed_json = json.loads(self.feed)
if 'entry' not in feed_json['feed']:
return
self.cells = feed_json['feed']['entry']
self.ncell = 0
event_fields = self.__... |
Get the events fields ( columns ) from the cells received. | def __get_event_fields(self):
"""Get the events fields (columns) from the cells received."""
event_fields = {}
# The cells in the first row are the column names
# Check that the columns names are the same we have as template
# Create the event template from the data retrieved
... |
Return data files in directory * dirname * | def get_data_files(dirname):
"""Return data files in directory *dirname*"""
flist = []
for dirpath, _dirnames, filenames in os.walk(dirname):
for fname in filenames:
flist.append(osp.join(dirpath, fname))
return flist |
Calculates the md5 - hash of the file.: param file_path: full path to the file. | def md5(file_path):
"""Calculates the md5-hash of the file.
:param file_path: full path to the file.
"""
hasher = hashlib.md5()
with open(file_path, 'rb') as f:
while True:
buf = f.read(BLOCKSIZE)
if not buf:
break
while len(buf... |
Shows file size.: param full_path: full path to the file. | def size(full_path):
"""Shows file size.
:param full_path: full path to the file.
"""
file_size = os.path.getsize(full_path)
str_file_size = str(file_size)
print(str_file_size, 'b')
# Show size in b, kb, mb or gb depending on the dimension
if len(str_file_size) >= 10:
... |
Split the tuple ( obtained from scan ) to separate files. Alternately send full paths to the files in md5 and call it.: param directory: tuple of files in the directory. | def calculate(directory):
"""Split the tuple (obtained from scan) to separate files.
Alternately send full paths to the files in md5 and call it.
:param directory: tuple of files in the directory."""
# Set correct slashes for the OS
if sys.platform == 'windows':
slash = '\\'
... |
Scan the directory and send the obtained tuple to calculate.: param tree: path to file or directory | def scan(tree):
"""Scan the directory and send the obtained tuple to calculate.
:param tree: path to file or directory"""
tree = os.path.normpath(tree)
assert os.path.exists(tree), "#Error. The path '{}' is" \
" invalid or doesn't exist.".format(str(tree))
... |
List of export formats. | def export_formats(self, pid_type):
"""List of export formats."""
if pid_type not in self._export_formats:
fmts = self.app.config.get('RECORDS_UI_EXPORT_FORMATS', {}).get(
pid_type, {})
self._export_formats[pid_type] = sorted(
[(k, v) for k, v in f... |
Load default permission factory. | def permission_factory(self):
"""Load default permission factory."""
if self._permission_factory is None:
imp = self.app.config['RECORDS_UI_DEFAULT_PERMISSION_FACTORY']
self._permission_factory = obj_or_import_string(imp)
return self._permission_factory |
Flask application initialization. | def init_app(self, app):
"""Flask application initialization.
:param app: The Flask application.
"""
self.init_config(app)
app.extensions['invenio-records-ui'] = _RecordUIState(app) |
Create Invenio - Records - UI blueprint. | def create_blueprint(endpoints):
"""Create Invenio-Records-UI blueprint.
The factory installs one URL route per endpoint defined, and adds an
error handler for rendering tombstones.
:param endpoints: Dictionary of endpoints to be installed. See usage
documentation for further details.
:ret... |
Create Werkzeug URL rule for a specific endpoint. | def create_url_rule(endpoint, route=None, pid_type=None, template=None,
permission_factory_imp=None, view_imp=None,
record_class=None, methods=None):
"""Create Werkzeug URL rule for a specific endpoint.
The method takes care of creating a persistent identifier resolver
... |
Display record view. | def record_view(pid_value=None, resolver=None, template=None,
permission_factory=None, view_method=None, **kwargs):
"""Display record view.
The two parameters ``resolver`` and ``template`` should not be included
in the URL rule, but instead set by creating a partially evaluated function
... |
r Display default view. | def default_view_method(pid, record, template=None, **kwargs):
r"""Display default view.
Sends record_viewed signal and renders template.
:param pid: PID object.
:param record: Record object.
:param template: Template to render.
:param \*\*kwargs: Additional view arguments based on URL rule.
... |
r Record serialization view. | def export(pid, record, template=None, **kwargs):
r"""Record serialization view.
Serializes record with given format and renders record export template.
:param pid: PID object.
:param record: Record object.
:param template: Template to render.
:param \*\*kwargs: Additional view arguments based... |
Load test data fixture. | def records():
"""Load test data fixture."""
import uuid
from invenio_records.api import Record
from invenio_pidstore.models import PersistentIdentifier, PIDStatus
# Record 1 - Live record
with db.session.begin_nested():
pid1 = PersistentIdentifier.create(
'recid', '1', obje... |
Send a Timer metric calculating duration of execution of the provided callable | def time_callable(self, name, target, rate=None, args=(), kwargs={}):
# type: (str, Callable, float, Tuple, Dict) -> Chronometer
"""Send a Timer metric calculating duration of execution of the provided callable"""
assert callable(target)
if rate is None:
rate = self._rate
... |
Close the socket to free system resources. | def close(self):
# type: () -> None
"""Close the socket to free system resources.
After the socket is closed, further operations with socket
will fail. Multiple calls to close will have no effect.
"""
if self._closed:
return
self._socket.close()
... |
Remove the client from the users of the socket. | def remove_client(self, client):
# type: (object) -> None
"""Remove the client from the users of the socket.
If there are no more clients for the socket, it
will close automatically.
"""
try:
self._clients.remove(id(client))
except ValueError:
... |
Increment a Counter metric | def increment(self, name, count=1, rate=1):
# type: (str, int, float) -> None
"""Increment a Counter metric"""
if self._should_send_metric(name, rate):
self._request(
Counter(
self._create_metric_name_for_request(name),
int(cou... |
Send a Timer metric with the specified duration in milliseconds | def timing(self, name, milliseconds, rate=1):
# type: (str, float, float) -> None
"""Send a Timer metric with the specified duration in milliseconds"""
if self._should_send_metric(name, rate):
milliseconds = int(milliseconds)
self._request(
Timer(
... |
Send a Timer metric calculating the duration from the start time | def timing_since(self, name, start_time, rate=1):
# type: (str, Union[float, datetime], float) -> None
"""Send a Timer metric calculating the duration from the start time"""
duration = 0 # type: float
if isinstance(start_time, datetime):
duration = (datetime.now(start_time.t... |
Send a Gauge metric with the specified value | def gauge(self, name, value, rate=1):
# type: (str, float, float) -> None
"""Send a Gauge metric with the specified value"""
if self._should_send_metric(name, rate):
if not is_numeric(value):
value = float(value)
self._request(
Gauge(
... |
Send a GaugeDelta metric to change a Gauge by the specified value | def gauge_delta(self, name, delta, rate=1):
# type: (str, float, float) -> None
"""Send a GaugeDelta metric to change a Gauge by the specified value"""
if self._should_send_metric(name, rate):
if not is_numeric(delta):
delta = float(delta)
self._request(
... |
Send a Set metric with the specified unique value | def set(self, name, value, rate=1):
# type: (str, str, float) -> None
"""Send a Set metric with the specified unique value"""
if self._should_send_metric(name, rate):
value = str(value)
self._request(
Set(
self._create_metric_name_for_... |
Override parent by buffering the metric instead of sending now | def _request(self, data):
# type: (str) -> None
"""Override parent by buffering the metric instead of sending now"""
data = bytearray("{}\n".format(data).encode())
self._prepare_batches_for_storage(len(data))
self._batches[-1].extend(data) |
Return a batch client with same settings of the client | def batch_client(self, size=512):
# type: (int) -> BatchClient
"""Return a batch client with same settings of the client"""
batch_client = BatchClient(self.host, self.port, self.prefix, size)
self._configure_client(batch_client)
return batch_client |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.