fiftyone.operators.utils

FiftyOne operator utilities.

Copyright 2017-2024, Voxel51, Inc.

voxel51.com

Classes:

ProgressHandler(ctx[, logger, level])

A logging handler that reports all logging messages issued while the handler’s context manager is active to the provided execution context’s set_progress() method.

Functions:

is_method_overridden(base_class, …)

Returns whether a method is overridden in a subclass.

class fiftyone.operators.utils.ProgressHandler(ctx, logger=None, level=None)

Bases: logging.Handler

A logging handler that reports all logging messages issued while the handler’s context manager is active to the provided execution context’s set_progress() method.

Parameters

• ctx – an fiftyone.operators.executor.ExecutionContext

• logger (None) – a specific logging.Logger for which to report records. By default, the root logger is used

• level (None) – an optional logging level above which to report records. By default, the logger’s effective level is used

Methods:

emit(record)	Do whatever it takes to actually log the specified logging record.
acquire()	Acquire the I/O thread lock.
addFilter(filter)	Add the specified filter to this handler.
close()	Tidy up any resources used by the handler.
createLock()	Acquire a thread lock for serializing access to the underlying I/O.
filter(record)	Determine if a record is loggable by consulting all the filters.
flush()	Ensure all logging output has been flushed.
format(record)	Format the specified record.
get_name()
handle(record)	Conditionally emit the specified logging record.
handleError(record)	Handle errors which occur during an emit() call.
release()	Release the I/O thread lock.
removeFilter(filter)	Remove the specified filter from this handler.
setFormatter(fmt)	Set the formatter for this handler.
setLevel(level)	Set the logging level of this handler.
set_name(name)

Attributes:

name

emit(record)

Do whatever it takes to actually log the specified logging record.

This version is intended to be implemented by subclasses and so raises a NotImplementedError.

acquire()

Acquire the I/O thread lock.

addFilter(filter)

Add the specified filter to this handler.

close()

Tidy up any resources used by the handler.

This version removes the handler from an internal map of handlers, _handlers, which is used for handler lookup by name. Subclasses should ensure that this gets called from overridden close() methods.

createLock()

Acquire a thread lock for serializing access to the underlying I/O.

filter(record)

Determine if a record is loggable by consulting all the filters.

The default is to allow the record to be logged; any filter can veto this and the record is then dropped. Returns a zero value if a record is to be dropped, else non-zero.

Changed in version 3.2: Allow filters to be just callables.

flush()

Ensure all logging output has been flushed.

This version does nothing and is intended to be implemented by subclasses.

format(record)

Format the specified record.

If a formatter is set, use it. Otherwise, use the default formatter for the module.

get_name()

handle(record)

Conditionally emit the specified logging record.

Emission depends on filters which may have been added to the handler. Wrap the actual emission of the record with acquisition/release of the I/O thread lock. Returns whether the filter passed the record for emission.

handleError(record)

Handle errors which occur during an emit() call.

This method should be called from handlers when an exception is encountered during an emit() call. If raiseExceptions is false, exceptions get silently ignored. This is what is mostly wanted for a logging system - most users will not care about errors in the logging system, they are more interested in application errors. You could, however, replace this with a custom handler if you wish. The record which was being processed is passed in to this method.

property name

release()

Release the I/O thread lock.

removeFilter(filter)

Remove the specified filter from this handler.

setFormatter(fmt)

Set the formatter for this handler.

setLevel(level)

Set the logging level of this handler. level must be an int or a str.

set_name(name)

fiftyone.operators.utils.is_method_overridden(base_class, sub_class_instance, method_name)

Returns whether a method is overridden in a subclass.

Parameters

• base_class – the base class

• sub_class_instance – an instance of the subclass

• method_name – the name of the method

Returns

True/False