adctk.file_publisher.FilePublisher Class Reference

This plugin generates and writes each message to the configured file, with \<adct-json>\</adct-json> delimiters surrounding it. More...

Inheritance diagram for adctk.file_publisher.FilePublisher:

Collaboration diagram for adctk.file_publisher.FilePublisher:

Public Member Functions
	__init__ (self)
int	config (self, **kwargs)
int	initialize (self)
	Set up any resources needed for reuse in publish().
int	publish (self, builder.Builder b)
	Publish json extracted from builder.
None	finalize (self)
	Clean up any resources set up in initialize (files, pipes, etc).
Public Member Functions inherited from adctk.publisher.Publisher
str	name (self)
	Get the name which a factory or error message should use.
str	version (self)
dict[str, str]	get_option_defaults (self)
None	pause (self)
	Cause publish calls to be ignored until resume is called.
None	resume (self)
	Cancel an prior calls to pause.
int	publish_str (self, str json_string)
int	publish_obj (self, obj)

Public Attributes
	defaults
	paused
	plugin_prefix
	debug
	fname
	fdir
	abspath
	fappend
	out
	mode
	state
Public Attributes inherited from adctk.publisher.Publisher
	defaults
	plugin_prefix
	paused
	state
	mode

Static Protected Attributes
str	_name = "file"
str	_version = "1.0.0"
Static Protected Attributes inherited from adctk.publisher.Publisher
str	_name = "unknown"
str	_version = "0.0.0"

Additional Inherited Members
Static Public Member Functions inherited from adctk.publisher.Publisher
tuple[float]	get_timeout_defaults ()
	Get the adc server connect and response timeouts defined in the environment ADC_SERVER_CONNECT_TIMEOUT and ADC_SERVER_POST_TIMEOUT as a tuple or default values if not defined.
str	get_url_default ()
	Get the alleged adc server url base from environment ADC_SERVER_URL or the default if it is not present.
str	get_port_default ()
	Get the adc server port number to use if it is properly defined in the environment ADC_SERVER_PORT or the default if it is not.
Static Public Attributes inherited from adctk.publisher.Publisher
	API_VERSION = adc_version.AdcVersion()._dict()
Protected Member Functions inherited from adctk.publisher.Publisher
str	_get (self, dict[str, str] opts, str field)
bool	_get_bool (self, dict[str, str] opts, str field)

Detailed Description

This plugin generates and writes each message to the configured file, with \<adct-json>\</adct-json> delimiters surrounding it.

The output directory is "." by default, but may be overriden with a full path defined in env("ADC_FILE_PLUGIN_DIRECTORY"). The file name is adc.file_plugin.log by default, and may be overridden with a path name in env("ADC_FILE_PLUGIN_FILE"). The file is overwritten when the file_plugin is created, unless env("ADC_FILE_PLUGIN_APPEND") is "true". Debug output (normally to stderr) is enabled if env("ADC_FILE_PLUGIN_DEBUG") is a number greater than 0.

Multiple independent file publishers may be created; if the same file name and directory are used for distinct instances, output file content is undefined.

Environment Variables:

• ADC_FILE_PLUGIN_DIRECTORY
• ADC_FILE_PLUGIN_FILE
• ADC_FILE_PLUGIN_APPEND
• ADC_FILE_PLUGIN_DEBUG

Constructor & Destructor Documentation

__init__()

adctk.file_publisher.FilePublisher.__init__

(

self

)

Reimplemented from adctk.publisher.Publisher.

    def __init__(self):
        super().__init__()
        self.defaults = _defaults
        self.paused = False
        self.plugin_prefix = "ADC_FILE_PLUGIN_"
        self.debug = 0
        self.fname = None
        self.fdir = None
        self.abspath = None
        self.fappend = False
        self.out = None
 

Member Function Documentation

config()

int adctk.file_publisher.FilePublisher.config	(		self,
		**	kwargs
	)

The config options for the file plugin are directory=<directory>,
   file=<leafname>, append="true" and debug=<int>.
   If not specified, then the environment variables ADC_FILE_PLUGIN_*
   are checked, where * is DIRECTORY, FILE, APPEND, and DEBUG.

Reimplemented from adctk.publisher.Publisher.

    def config(self, **kwargs) -> int:
        """The config options for the file plugin are directory=<directory>,
           file=<leafname>, append="true" and debug=<int>.
           If not specified, then the environment variables ADC_FILE_PLUGIN_*
           are checked, where * is DIRECTORY, FILE, APPEND, and DEBUG.
        """
        try:
            self.fappend =  self._get_bool(kwargs, "APPEND")
            self.fdir = self._get(kwargs, "DIRECTORY")
            self.fname = self._get(kwargs, "FILE")
            self.debug = int( self._get(kwargs, "DEBUG") )
            if self.debug > 0:
                log.logger.info("file plugin configured")
            self.mode = publisher.Publisher.Mode.INIT
            return 0
        except ValueError as e:
            log.logger.error("adctk.Filepublisher.Publisher.config: invalid options"\
                    "or environment %s* values: %s", self.plugin_prefix, e)
            return 1
 

finalize()

None adctk.file_publisher.FilePublisher.finalize

(

self

)

Clean up any resources set up in initialize (files, pipes, etc).

Reimplemented from adctk.publisher.Publisher.

    def finalize(self) -> None:
        self.state = publisher.Publisher.State.OK
        self.paused = False
        self.mode = publisher.Publisher.Mode.CONFIG
        if self.out:
            self.out.close()
            self.out = None

initialize()

int adctk.file_publisher.FilePublisher.initialize

(

self

)

Set up any resources needed for reuse in publish().

Reimplemented from adctk.publisher.Publisher.

    def initialize(self) -> int:
        # pylint: disable=too-many-return-statements
        if self.state == publisher.Publisher.State.ERR:
            return errno.ENOTRECOVERABLE
        if self.mode == publisher.Publisher.Mode.CONFIG:
            self.config()
        if self.mode != publisher.Publisher.Mode.INIT:
            return errno.EINVAL
        if self.state == publisher.Publisher.State.ERR:
            log.logger.error("adctk.FilePublisher.initialize: unexpected 'state' found.")
            return errno.ENOTRECOVERABLE
        checkdir = pathlib.Path(self.fdir)
        dirmade = False
        try:
            checkdir.mkdir(parents=True, exist_ok=True)
            dirmade = True
        except FileExistsError:
            log.logger.error("adctk.FilePublisher.initialize: An existing file cannot be "\
                    "converted to a directory in path %s", self.fdir)
            self.state = publisher.Publisher.State.ERR
            return errno.EEXIST
        except PermissionError:
            log.logger.error("adctk.FilePublisher.initialize: permission denied "\
                    "along path %s", self.fdir)
            self.state = publisher.Publisher.State.ERR
            return errno.EPERM
        except OSError as e:
            log.logger.error("adctk.FilePublisher.initialize: unexpected OSError. %s", e)
            self.state = publisher.Publisher.State.ERR
            return errno.EIO
        if not dirmade:
            self.state = publisher.Publisher.State.ERR
            return errno.EINVAL
        self.abspath = (pathlib.Path(self.fdir) / self.fname).absolute()
        if self.fappend:
            filemode = "ab"
        else:
            filemode = "wb"
        try:
            # pylint: disable-next=consider-using-with
            self.out = open(self.abspath, filemode)
            if self.out is None:
                self.state = publisher.Publisher.State.ERR
                return errno.EBADF
            self.mode = publisher.Publisher.Mode.PUB_OR_FINAL
            return 0
        except (FileNotFoundError, PermissionError, IsADirectoryError, IOError, OSError):
            log.logger.error("adctk.FilePublisher.initialize: unable to open %s", self.abspath)
            self.state = publisher.Publisher.State.ERR
            self.out = None
            return errno.EBADF
 

publish()

int adctk.file_publisher.FilePublisher.publish	(		self,
		builder.Builder	b
	)

Publish json extracted from builder.

Reimplemented from adctk.publisher.Publisher.

    def publish(self, b: builder.Builder) -> int:
        if self.paused:
            return 0
        if self.state != publisher.Publisher.State.OK:
            return 1
        if self.mode != publisher.Publisher.Mode.PUB_OR_FINAL:
            return 2
        if self.out is None:
            return 3
        try:
            message = f"<adct-json>{b.serialize()}</adct-json>\n"
            self.out.write(message.encode('utf-8'))
        except (FileNotFoundError, PermissionError, IsADirectoryError, IOError, OSError):
            self.state = publisher.Publisher.State.ERR
            log.logger.error("adctk.FilePublisher.publish: write failed to %s", self.abspath)
            self.out.close()
            self.out = None
        return 0
 

Member Data Documentation

_name

str adctk.file_publisher.FilePublisher._name = "file"

staticprotected

_version

str adctk.file_publisher.FilePublisher._version = "1.0.0"

staticprotected

abspath

adctk.file_publisher.FilePublisher.abspath

debug

adctk.file_publisher.FilePublisher.debug

defaults

adctk.file_publisher.FilePublisher.defaults

fappend

adctk.file_publisher.FilePublisher.fappend

fdir

adctk.file_publisher.FilePublisher.fdir

fname

adctk.file_publisher.FilePublisher.fname

mode

adctk.file_publisher.FilePublisher.mode

out

adctk.file_publisher.FilePublisher.out

paused

adctk.file_publisher.FilePublisher.paused

plugin_prefix

adctk.file_publisher.FilePublisher.plugin_prefix

state

adctk.file_publisher.FilePublisher.state

---

The documentation for this class was generated from the following file:

• src/adctk/file_publisher.py