a d=ic5@sdZddlmZddlmZGdddedZGdddeZGd d d eZGd d d eZGd ddeZ Gddde Z dS)zTensorBoard Plugin abstract base class. Every plugin in TensorBoard must extend and implement the abstract methods of this base class. )ABCMeta)abstractmethodc@sDeZdZdZdZddZeddZeddZd d Z d d Z dS) TBPluginaTensorBoard plugin interface. Every plugin must extend from this class. Subclasses should have a trivial constructor that takes a TBContext argument. Any operation that might throw an exception should either be done lazily or made safe with a TBLoader subclass, so the plugin won't negatively impact the rest of TensorBoard. Fields: plugin_name: The plugin_name will also be a prefix in the http handlers, e.g. `data/plugins/$PLUGIN_NAME/$HANDLER` The plugin name must be unique for each registered plugin, or a ValueError will be thrown when the application is constructed. The plugin name must only contain characters among [A-Za-z0-9_.-], and must be nonempty, or a ValueError will similarly be thrown. NcCsdS)zInitializes this plugin. The default implementation does nothing. Subclasses are encouraged to override this and save any necessary fields from the `context`. Args: context: A `base_plugin.TBContext` object. Nselfcontextrrp/home/droni/.local/share/virtualenvs/DPS-5Je3_V2c/lib/python3.9/site-packages/tensorboard/plugins/base_plugin.py__init__/s zTBPlugin.__init__cCs tdS)aaReturns a set of WSGI applications that the plugin implements. Each application gets registered with the tensorboard app and is served under a prefix path that includes the name of the plugin. Returns: A dict mapping route paths to WSGI applications. Each route path should include a leading slash. NNotImplementedErrorrrrr get_plugin_apps:s zTBPlugin.get_plugin_appscCs tdS)a"Determines whether this plugin is active. A plugin may not be active for instance if it lacks relevant data. If a plugin is inactive, the frontend may avoid issuing requests to its routes. Returns: A boolean value. Whether this plugin is active. Nr r rrr is_activeGs zTBPlugin.is_activecCstS)a?Defines how the plugin will be displayed on the frontend. The base implementation returns a default value. Subclasses should override this and specify either an `es_module_path` or (for legacy plugins) an `element_name`, and are encouraged to set any other relevant attributes. )FrontendMetadatar rrr frontend_metadataSszTBPlugin.frontend_metadatacCs|jfS)a.Experimental. Lists plugins whose summary data this plugin reads. Returns: A collection of strings representing plugin names (as read from `SummaryMetadata.plugin_data.plugin_name`) from which this plugin may read data. Defaults to `(self.plugin_name,)`. ) plugin_namer rrr data_plugin_names]szTBPlugin.data_plugin_names) __name__ __module__ __qualname____doc__rr rrrrrrrrr rs    r) metaclassc@seZdZdZdddddddddZeddZedd Zed d Zed d Z eddZ eddZ ddZ ddZ ddZdS)rzMetadata required to render a plugin on the frontend. Each argument to the constructor is publicly accessible under a field of the same name. See constructor docs for further details. N)disable_reload element_namees_module_path remove_domtab_nameis_ng_componentcCsL|dur dn||_||_||_|dur*dn||_||_|durBdn||_dS)a2Creates a `FrontendMetadata` value. The argument list is sorted and may be extended in the future; therefore, callers must pass only named arguments to this constructor. Args: disable_reload: Whether to disable the reload button and auto-reload timer. A `bool`; defaults to `False`. element_name: For legacy plugins, name of the custom element defining the plugin frontend: e.g., `"tf-scalar-dashboard"`. A `str` or `None` (for iframed plugins). Mutually exclusive with `es_module_path`. es_module_path: ES module to use as an entry point to this plugin. A `str` that is a key in the result of `get_plugin_apps()`, or `None` for legacy plugins bundled with TensorBoard as part of `webfiles.zip`. Mutually exclusive with legacy `element_name` remove_dom: Whether to remove the plugin DOM when switching to a different plugin, to trigger the Polymer 'detached' event. A `bool`; defaults to `False`. tab_name: Name to show in the menu item for this dashboard within the navigation bar. May differ from the plugin name: for instance, the tab name should not use underscores to separate words. Should be a `str` or `None` (the default; indicates to use the plugin name as the tab name). is_ng_component: Set to `True` only for built-in Angular plugins. In this case, the `plugin_name` property of the Plugin, which is mapped to the `id` property in JavaScript's `UiPluginMetadata` type, is used to select the Angular component. A `True` value is mutually exclusive with `element_name` and `es_module_path`. NF)_disable_reload _element_name_es_module_path _remove_dom _tab_name_is_ng_component)rrrrrrrrrr r os*zFrontendMetadata.__init__cCs|jSN)rr rrr rszFrontendMetadata.disable_reloadcCs|jSr%)r r rrr rszFrontendMetadata.element_namecCs|jSr%)r$r rrr rsz FrontendMetadata.is_ng_componentcCs|jSr%)r!r rrr rszFrontendMetadata.es_module_pathcCs|jSr%)r"r rrr rszFrontendMetadata.remove_domcCs|jSr%)r#r rrr rszFrontendMetadata.tab_namecCsrt|tsdS|j|jkrdS|j|jkr.dS|j|jkr>dS|j|jkrNdS|j|jkr^dS|j|jkrndSdS)NFT) isinstancerrr r!r"r#)rotherrrr __eq__s       zFrontendMetadata.__eq__cCs t|j|j|j|j|j|jfSr%)hashrr r!r"r#r$r rrr __hash__szFrontendMetadata.__hash__c Cs>ddd|jd|jd|jd|jd|jd|jfS) NzFrontendMetadata(%s)z, zdisable_reload=%rzelement_name=%rzes_module_path=%rz remove_dom=%rz tab_name=%rzis_ng_component=%r)joinrr r!r"r#r$r rrr __repr__szFrontendMetadata.__repr__)rrrrr propertyrrrrrrr(r*r,rrrr rhs.  4       rc @s,eZdZdZdddddddddddZdS) TBContextaMagic container of information passed from TensorBoard core to plugins. A TBContext instance is passed to the constructor of a TBPlugin class. Plugins are strongly encouraged to assume that any of these fields can be None. In cases when a field is considered mandatory by a plugin, it can either crash with ValueError, or silently choose to disable itself by returning False from its is_active method. All fields in this object are thread safe. Nassets_zip_provider data_providerflagslogdir multiplexerplugin_name_to_instancesampling_hints window_titlec Cs4||_||_||_||_||_||_||_||_dS)aInstantiates magic container. The argument list is sorted and may be extended in the future; therefore, callers must pass only named arguments to this constructor. Args: assets_zip_provider: A function that returns a newly opened file handle for a zip file containing all static assets. The file names inside the zip file are considered absolute paths on the web server. The file handle this function returns must be closed. It is assumed that you will pass this file handle to zipfile.ZipFile. This zip file should also have been created by the tensorboard_zip_file build rule. data_provider: Instance of `tensorboard.data.provider.DataProvider`. May be `None` if `flags.generic_data` is set to `"false"`. flags: An object of the runtime flags provided to TensorBoard to their values. logdir: The string logging directory TensorBoard was started with. multiplexer: An EventMultiplexer with underlying TB data. Plugins should copy this data over to the database when the db fields are set. plugin_name_to_instance: A mapping between plugin name to instance. Plugins may use this property to access other plugins. The context object is passed to plugins during their construction, so a given plugin may be absent from this mapping until it is registered. Plugin logic should handle cases in which a plugin is absent from this mapping, lest a KeyError is raised. sampling_hints: Map from plugin name to `int` or `NoneType`, where the value represents the user-specified downsampling limit as given to the `--samples_per_plugin` flag, or `None` if none was explicitly given for this plugin. window_title: A string specifying the window title. Nr/) rr0r1r2r3r4r5r6r7rrr r s+zTBContext.__init__)rrrrr rrrr r.sr.c@s(eZdZdZddZddZddZdS) TBLoaderaTBPlugin factory base class. Plugins can override this class to customize how a plugin is loaded at startup. This might entail adding command-line arguments, checking if optional dependencies are installed, and potentially also specializing the plugin class at runtime. When plugins use optional dependencies, the loader needs to be specified in its own module. That way it's guaranteed to be importable, even if the `TBPlugin` itself can't be imported. Subclasses must have trivial constructors. cCsdS)aAdds plugin-specific CLI flags to parser. The default behavior is to do nothing. When overriding this method, it's recommended that plugins call the `parser.add_argument_group(plugin_name)` method for readability. No flags should be specified that would cause `parse_args([])` to fail. Args: parser: The argument parsing object, which may be mutated. Nr)rparserrrr define_flags5s zTBLoader.define_flagscCsdS)aAllows flag values to be corrected or validated after parsing. Args: flags: The parsed argparse.Namespace object. Raises: base_plugin.FlagsError: If a flag is invalid or a required flag is not passed. Nr)rr2rrr fix_flagsCs zTBLoader.fix_flagscCsdS)a7Loads a TBPlugin instance during the setup phase. Args: context: The TBContext instance. Returns: A plugin instance or None if it could not be loaded. Loaders that return None are skipped. :type context: TBContext :rtype: TBPlugin | None Nrrrrr loadOs z TBLoader.loadN)rrrrr:r;r<rrrr r8&s r8c@s eZdZdZddZddZdS) BasicLoaderz3Simple TBLoader that's sufficient for most plugins.cCs ||_dS)z^Creates simple plugin instance maker. :param plugin_class: :class:`TBPlugin` N plugin_class)rr?rrr r bszBasicLoader.__init__cCs ||Sr%r>rrrr r<iszBasicLoader.loadN)rrrrr r<rrrr r=_sr=c@seZdZdZdS) FlagsErrorz?Raised when a command line flag is not specified or is invalid.N)rrrrrrrr r@msr@N) rabcrrrobjectrr.r8r= ValueErrorr@rrrr s  N}A9