ioana.circu - logging

[lr154lrose]

Added logger

• Option to disable logging
• Option to log to console or only to file

[dwest77a]

Adding this comment here but it can apply in many places. Consider using type hints for the parameters of functions. In this case enable_logging: bool = True etc.

If multiple variable types are acceptable, you can use the following:

from typing import Union
...
enable_logging: Union[bool,None] = None

[dwest77a]

Can use the updated syntax for opening files:

with open(file) as f: # 'r' is default if not specified.
    content = [r.strip() for r in f.readlines()] # Removes the '\n' from all lines

[dwest77a]

Can just use elasticsearc.ceda.ac.uk now.

[dwest77a]

Look into python Abstract Base Classes at https://www.geeksforgeeks.org/abstract-classes-in-python/

This is something Dave suggested but I know less about. The preprocess_records function is overridden by subclasses (not sure where), which is exactly the use case for an ABC class.

[dwest77a]

Don't need the Debug: part of the string if your log message already adds this.

[dwest77a]

Few additional comments for suggested changes to other parts of the code:

• Put all .py files inside the flightpipe module (then they can be part of the main package)
• Any script you would normally use like python <script_name> can then instead use an entrypoint in the pyproject.toml file project.scripts section (see cci-os-worker)
• Any new python scripts you create, including the cli.py file - add the sections below to the file:

__author__    = "Ioana Circu"
__contact__   = "ioana.circu@stfc.ac.uk"
__copyright__ = "Copyright 2025 United Kingdom Research and Innovation"

Along with a copy of the License file from another project that sits in the top of the repository.

[dwest77a]

Great, looks like all the logging changes are fine and working so you can merge this branch into main now!