Main

class ffflash.main.FFFlash(args)

This is the main object, which stores all relevant information, and the ffflash.lib.api.FFApi itself.

Parameters:args – Namespace object from ffflash.lib.args.parsed_args()

access_for(name)

Check if it is save to access the api and/or depending files.

Parameters:name – String specifier of part to access. Returns:True or False

load_api()

Populate api with ffflash.lib.api.FFApi with content loaded from location.

api is populated only once, this prevents accidental reloads.

log(message, level=True)

Very advanced Logger. For professional use only.

Parameters:

• message – Some message string to display
• level –

  Severity of message. Can be anything as this is also the return value. There are three predefined rules:

  • True: info (is dismissed unless --verbose was given)
  • None: warn
  • False: error

Returns:

level

save()

Save content from api (ffflash.lib.api.FFApi) into location. A ffflash.lib.api.FFApi.timestamp() is triggered before saving.

set_timestamp()

Inject ffflash.lib.clock.get_iso_timestamp() into state.lastchange.

ffflash.main.run(argv=None)

Main function of FFFlash.

Info

To share common values like the package name or release string between setuptools, sphinx and the code itself, the info module is used.

class ffflash.info.Info

Shared Information is stored in a class, for easy access.

rst_epilog

Return str:Restructured Text with substitutions for the info values, so they can be displayed in sphinx documentation