larigira package

Subpackages

• larigira.filters package
  • Submodules
  • larigira.filters.basic module
    • get_duration()
    • maxwait()
    • percentwait()
  • Module contents

Submodules

larigira.audioform_base module

class larigira.audioform_base.BaseForm(*args, **kwargs)

Bases: FlaskForm

larigira.audioform_http module

class larigira.audioform_http.AudioForm(*args, **kwargs)

Bases: BaseForm

nick = <UnboundField(StringField, ('Audio nick',), {'validators': [<wtforms.validators.Required object>], 'description': 'A simple name to recognize this audio'})>

populate_from_audiospec(audiospec)

submit = <UnboundField(SubmitField, ('Submit',), {})>

urls = <UnboundField(StringField, ('URLs',), {'validators': [<wtforms.validators.Required object>], 'description': 'URL of the file to download'})>

larigira.audioform_http.audio_receive(form)

larigira.audioform_mostrecent module

class larigira.audioform_mostrecent.AudioForm(*args, **kwargs)

Bases: BaseForm

maxage = <UnboundField(StringField, ('Max age',), {'validators': [<wtforms.validators.Required object>], 'description': 'in seconds, or human-readable (like 9w3d12h)'})>

nick = <UnboundField(StringField, ('Audio nick',), {'validators': [<wtforms.validators.Required object>], 'description': 'A simple name to recognize this audio'})>

path = <UnboundField(AutocompleteStringField, ('dl-suggested-dirs', 'Path'), {'validators': [<wtforms.validators.Required object>], 'description': 'Directory to pick file from'})>

populate_from_audiospec(audiospec)

submit = <UnboundField(SubmitField, ('Submit',), {})>

validate_maxage(field)

larigira.audioform_mostrecent.audio_receive(form)

larigira.audioform_podcast module

class larigira.audioform_podcast.AudioForm(*args, **kwargs)

Bases: BaseForm

max_len = <UnboundField(StringField, ('Accetta solo audio lunghi al massimo:',), {'description': 'Leaving this empty will disable this filter'})>

min_len = <UnboundField(StringField, ('Accetta solo audio lunghi almeno:',), {'description': 'Leaving this empty will disable this filter'})>

nick = <UnboundField(StringField, ('Audio nick',), {'validators': [<wtforms.validators.Required object>], 'description': 'A simple name to recognize this audio'})>

populate_from_audiospec(audiospec)

reverse = <UnboundField(BooleanField, ('Reverse sort (descending)',), {})>

sort_by = <UnboundField(SelectField, ('Sort episodes',), {'choices': [('none', "Don't sort"), ('random', 'Random'), ('duration', 'Duration'), ('date', 'date')]})>

start = <UnboundField(IntegerField, ('Play from episode number',), {'description': 'Episodes count from 0; 0 is a sane default'})>

submit = <UnboundField(SubmitField, ('Submit',), {})>

url = <UnboundField(URLField, ('URL',), {'validators': [<wtforms.validators.Required object>], 'description': 'URL of the podcast; it must be valid xml'})>

larigira.audioform_podcast.audio_receive(form)

larigira.audioform_randomdir module

class larigira.audioform_randomdir.Form(*args, **kwargs)

Bases: BaseForm

howmany = <UnboundField(IntegerField, ('Number',), {'validators': [<wtforms.validators.Optional object>], 'default': 1, 'description': 'How many songs to be pickedfrom this dir; defaults to 1'})>

nick = <UnboundField(StringField, ('Audio nick',), {'validators': [<wtforms.validators.Required object>], 'description': 'A simple name to recognize this audio'})>

path = <UnboundField(AutocompleteStringField, ('dl-suggested-dirs', 'Path'), {'validators': [<wtforms.validators.Required object>], 'description': 'Full path to source directory'})>

populate_from_audiospec(audiospec)

submit = <UnboundField(SubmitField, ('Submit',), {})>

larigira.audioform_randomdir.receive(form)

larigira.audioform_script module

class larigira.audioform_script.ScriptAudioForm(*args, **kwargs)

Bases: BaseForm

args = <UnboundField(StringField, ('Arguments',), {'description': 'arguments, separated by ";"'})>

name = <UnboundField(AutocompleteStringField, ('dl-suggested-scripts', 'Name'), {'validators': [<wtforms.validators.Required object>], 'description': 'filename (NOT path) of the script'})>

nick = <UnboundField(StringField, ('Audio nick',), {'validators': [<wtforms.validators.Required object>], 'description': 'A simple name to recognize this audio'})>

populate_from_audiospec(audiospec)

submit = <UnboundField(SubmitField, ('Submit',), {})>

validate_name(field)

larigira.audioform_script.scriptaudio_receive(form)

larigira.audioform_static module

class larigira.audioform_static.StaticAudioForm(*args, **kwargs)

Bases: BaseForm

nick = <UnboundField(StringField, ('Audio nick',), {'validators': [<wtforms.validators.Required object>], 'description': 'A simple name to recognize this audio'})>

path = <UnboundField(AutocompleteStringField, ('dl-suggested-files', 'Path'), {'validators': [<wtforms.validators.Required object>], 'description': 'Full path to audio file'})>

populate_from_audiospec(audiospec)

submit = <UnboundField(SubmitField, ('Submit',), {})>

larigira.audioform_static.staticaudio_receive(form)

larigira.audiogen module

larigira.audiogen.audiogenerate(spec)

larigira.audiogen.check_spec(spec)

larigira.audiogen.get_audiogenerator(kind)

Messes with entrypoints to return an audiogenerator function

larigira.audiogen.get_parser()

larigira.audiogen.main()

Main function for the “larigira-audiogen” executable

larigira.audiogen.read_spec(fname)

larigira.audiogen_http module

larigira.audiogen_http.generate(spec)

resolves audiospec-static

Recognized argument is “paths” (list of static paths)

larigira.audiogen_mostrecent module

larigira.audiogen_mostrecent.generate(spec)

resolves audiospec-randomdir

Recognized arguments:

• path [mandatory] source dir

• maxage [default=ignored] max age of audio files to pick

larigira.audiogen_mostrecent.get_mtime(fname)

larigira.audiogen_mostrecent.recent_choose(paths, howmany, minepoch)

larigira.audiogen_mpdrandom module

larigira.audiogen_mpdrandom.generate_by_artist(spec)

Choose HOWMANY random artists, and for each one choose a random song.

larigira.audiogen_podcast module

class larigira.audiogen_podcast.Audio(url, duration=None, date=None)

Bases: object

property age

property duration

lazy-calculation

property urls

property valid

larigira.audiogen_podcast.delta_humanreadable(tdelta)

larigira.audiogen_podcast.generate(spec)

larigira.audiogen_podcast.get_audio_from_item(item)

larigira.audiogen_podcast.get_duration(url)

larigira.audiogen_podcast.get_item_date(el)

larigira.audiogen_podcast.get_tree(feed_url)

larigira.audiogen_podcast.get_urls(tree)

larigira.audiogen_podcast.parse_duration(arg)

larigira.audiogen_randomdir module

larigira.audiogen_randomdir.candidates(paths)

larigira.audiogen_randomdir.generate(spec)

resolves audiospec-randomdir

Recognized arguments:

• paths [mandatory] list of source paths

• howmany [default=1] number of audio files to pick

larigira.audiogen_script module

script audiogenerator: uses an external program to generate audio URIs

a script can be any valid executable in $XDG_CONFIG_DIR/larigira/scripts/<name>; for security reasons, it must be executable and owned by the current user. The audiospec can specify arguments to the script, while the environment cannot be customized (again, this is for security reasons).

The script should assume a minimal environment, and being run from /. It must output one URI per line; please remember that URI must be understood from mpd, so file paths are not valid; file:///file/path.ogg is a valid URI instead. The output MUST be UTF-8-encoded. Empty lines will be skipped. stderr will be logged, so please be careful. any non-zero exit code will result in no files being added.and an exception being logged.

larigira.audiogen_script.generate(spec)

Recognized arguments (fields in spec):

• name [mandatory] script name

• args [default=empty] arguments, colon-separated

larigira.audiogen_static module

larigira.audiogen_static.generate(spec)

resolves audiospec-static

Recognized argument is “paths” (list of static paths)

larigira.config module

Taken from flask-appconfig

larigira.config.from_envvars(prefix=None, envvars=None, as_json=True)

Load environment variables in a dictionary

Values are parsed as JSON. If parsing fails with a ValueError, values are instead used as verbatim strings.

Parameters:

• prefix – If None is passed as envvars, all variables from environ starting with this prefix are imported. The prefix is stripped upon import.

• envvars – A dictionary of mappings of environment-variable-names to Flask configuration names. If a list is passed instead, names are mapped 1:1. If None, see prefix argument.

• as_json – If False, values will not be parsed as JSON first.

larigira.config.get_conf(prefix='LARIGIRA_')

This is where everyone should get configuration from

larigira.db module

class larigira.db.EventModel(uri, additional_db_dir=None)

Bases: object

add_action(action)

add_alarm(alarm)

add_event(alarm, actions)

static canonicalize(eid_or_aid: str | int) → str

delete_action(*args, **kwargs)

delete_alarm(*args, **kwargs)

get_action_by_id(action_id: str | int)

get_actions_by_alarm(alarm)

get_alarm_by_id(alarm_id)

get_all_actions() → list

get_all_alarms() → list

get_all_alarms_expanded()

static parse_id(eid_or_aid: str | int) → Tuple[str, int]

reload()

update_action(*args, **kwargs)

update_alarm(*args, **kwargs)

exception larigira.db.ReadOnlyException

Bases: ValueError

class larigira.db.ReadOnlyMiddleware(storage_cls=<class 'tinydb.storages.JSONStorage'>)

Bases: Middleware

Make sure no write ever occurs

write(data)

larigira.db.only_main(f)

assumes first argument is id, and must be “main”

larigira.entrypoints_utils module

larigira.entrypoints_utils.get_avail_entrypoints(group)

larigira.entrypoints_utils.get_one_entrypoint(group, kind)

Messes with entrypoints to return an entrypoint of a given group/kind

larigira.event module

class larigira.event.Monitor(parent_queue, conf)

Bases: ParentedLet

Manages timegenerators and audiogenerators for DB events

The mechanism is partially based on ticks, partially on scheduled actions. Ticks are emitted periodically; at every tick, on_tick checks if any event is “near enough”. If an event is near enough, it is “scheduled”: a greenlet is run which will wait for the right time, then generate the audio, then submit to Controller.

The tick mechanism allows for events to be changed on disk: if everything was scheduled immediately, no further changes would be possible. The scheduling mechanism allows for more precision, catching exactly the right time. Being accurate only with ticks would have required very frequent ticks, which is cpu-intensive.

on_tick()

this is called every EVENT_TICK_SECS. Checks every event in the DB (which might be slightly CPU-intensive, so it is advisable to run it in its own greenlet); if the event is “near enough”, schedule it; if it is too far, or already expired, ignore it.

process_action(timespec, audiospecs)

Generate audio and submit it to Controller

schedule(timespec, audiospecs, delta=None)

prepare an event to be run at a specified time with the specified actions; the DB won’t be read anymore after this call.

This means that this call should not be done too early, or any update to the DB will be ignored.

larigira.event_manage module

larigira.event_manage.main()

larigira.event_manage.main_add(args)

larigira.event_manage.main_getaction(args)

larigira.event_manage.main_list(args)

larigira.eventutils module

class larigira.eventutils.ParentedLet(queue)

Bases: Greenlet

ParentedLet is just a helper subclass that will help you when your greenlet main duty is to “signal” things to a parent_queue.

It won’t save you much code, but “standardize” messages and make explicit the role of that greenlet

parent_msg(kind, *args)

send_to_parent(kind, *args)

class larigira.eventutils.Timer(milliseconds, queue)

Bases: ParentedLet

continously sleeps some time, then send a “timer” message to parent

do_business()

parent_msg(kind, *args)

larigira.forms module

larigira.forms.get_audioform(kind)

Messes with entrypoints to return a AudioForm

larigira.forms.get_timeform(kind)

Messes with entrypoints to return a TimeForm

larigira.formutils module

class larigira.formutils.AutocompleteStringField(*args, **kwargs)

Bases: StringField

class larigira.formutils.AutocompleteTextInput(datalist=None)

Bases: Input

class larigira.formutils.DateTimeInput(input_type=None)

Bases: Input

input_type = 'datetime-local'

class larigira.formutils.EasyDateTimeField(*args, **kwargs)

Bases: Field

a “fork” of DateTimeField which uses HTML5 datetime-local

The format is not customizable, because it is imposed by the HTML5 specification.

This field does not ensure that browser actually supports datetime-local input type, nor does it provide polyfills.

formats = ('%Y-%m-%dT%H:%M:%S', '%Y-%m-%dT%H:%M')

process_formdata(valuelist)

Process data received over the wire from a form.

This will be called during form construction with data supplied through the formdata argument.

Parameters:

valuelist – A list of strings to process.

widget = <larigira.formutils.DateTimeInput object>

larigira.fsutils module

larigira.fsutils.download_http(url, destdir=None, copy=False, prefix='httpdl')

larigira.fsutils.http_expected_length(url)

larigira.fsutils.is_audio(fname)

larigira.fsutils.multi_fnmatch(fname, extensions)

larigira.fsutils.scan_dir(dirname, extension=None)

larigira.fsutils.scan_dir_audio(dirname, extensions=('mp3', 'oga', 'wav', 'ogg'))

larigira.fsutils.shortname(path)

larigira.main module

This module is for the main application logic

class larigira.main.Larigira

Bases: object

start()

larigira.main.main()

larigira.main.on_main_crash(*args, **kwargs)

larigira.main.sd_notify(ready=False, status=None)

larigira.mpc module

class larigira.mpc.Controller(conf)

Bases: Greenlet

class larigira.mpc.MPDWatcher(queue, conf, client=None)

Bases: ParentedLet

MPDWatcher notifies parent about any mpd event

do_business()

refresh_client()

class larigira.mpc.Player(conf)

Bases: object

The player contains different mpd-related methods

check_playlist determines whether the playlist is long enough and run audiogenerator accordingly

enqueue receive audios that have been generated by Monitor and (if filters allow it) enqueue it to MPD playlist

check_playlist()

property continous_audiospec

enqueue(songs)

enqueue_filter(songs)

play()

make sure that MPD is playing

larigira.mpc.get_mpd_client(conf)

larigira.test_unused module

larigira.test_unused.test_watch_file(unusedcleaner)

larigira.test_unused.test_watch_notmp_error(unusedcleaner)

Files not in TMPDIR are not added

larigira.test_unused.test_watch_path_error(unusedcleaner)

paths are not valid thing to watch. URIs only, thanks

larigira.test_unused.unusedcleaner()

larigira.timeform_base module

class larigira.timeform_base.BaseForm(*args, **kwargs)

Bases: FlaskForm

classmethod field_exclude()

classmethod form_receive(form) → dict

classmethod get_kind() → str

populate_from_timespec(timespec)

validate_exclude(field)

class larigira.timeform_base.FrequencyAlarmForm(*args, **kwargs)

Bases: BaseForm

end = <UnboundField(EasyDateTimeField, ('End date and time',), {'validators': [<wtforms.validators.Optional object>], 'description': 'After this, no alarm will ring. Expressed as YYYY-MM-DDTHH:MM:SS. If omitted, the alarm will always ring'})>

exclude = <UnboundField(TextAreaField, ('Any matching time will be excluded',), {'description': 'Supported formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS or cron-like format'})>

static form_receive(form) → dict

classmethod get_kind()

interval = <UnboundField(StringField, ('Frequency',), {'validators': [<wtforms.validators.Required object>], 'description': 'in seconds, or human-readable (like 9w3d12h)'})>

nick = <UnboundField(StringField, ('Alarm nick',), {'validators': [<wtforms.validators.Required object>], 'description': 'A simple name to recognize this alarm'})>

populate_from_timespec(timespec)

start = <UnboundField(EasyDateTimeField, ('Start date and time',), {'validators': [<wtforms.validators.Optional object>], 'description': 'Before this, no alarm will ring. Expressed as YYYY-MM-DDTHH:MM:SS. If omitted, the alarm will always ring'})>

submit = <UnboundField(SubmitField, ('Submit',), {})>

validate_interval(field)

weekdays = <UnboundField(SelectMultipleField, ('Days on which the alarm should be played',), {'choices': [('1', 'Monday'), ('2', 'Tuesday'), ('3', 'Wednesday'), ('4', 'Thursday'), ('5', 'Friday'), ('6', 'Saturday'), ('7', 'Sunday')], 'default': ['1', '2', '3', '4', '5', '6', '7'], 'validators': [<wtforms.validators.Required object>], 'description': 'The alarm will ring only on selected weekdays'})>

class larigira.timeform_base.SingleAlarmForm(*args, **kwargs)

Bases: BaseForm

dt = <UnboundField(EasyDateTimeField, ('Date and time',), {'validators': [<wtforms.validators.Required object>], 'description': 'Date to ring on, expressed as 2000-12-31T13:42:00'})>

classmethod form_receive() → dict

classmethod get_kind() → str

nick = <UnboundField(StringField, ('Alarm nick',), {'validators': [<wtforms.validators.Required object>], 'description': 'A simple name to recognize this alarm'})>

populate_from_timespec(timespec)

submit = <UnboundField(SubmitField, ('Submit',), {})>

larigira.timeform_cron module

class larigira.timeform_cron.CronAlarmForm(*args, **kwargs)

Bases: BaseForm

cron_format = <UnboundField(StringField, ('cron-like format',), {'validators': [<wtforms.validators.Required object>], 'description': 'the frequency specification, as in the <tt>cron</tt> command; see <a href="https://crontab.guru/">crontab.guru</a> for a hepl with cron format'})>

exclude = <UnboundField(TextAreaField, ('Any matching time will be excluded',), {'description': 'Supported formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS or cron-like format'})>

classmethod form_receive(form) → dict

classmethod get_kind()

nick = <UnboundField(StringField, ('Alarm nick',), {'validators': [<wtforms.validators.Required object>], 'description': 'A simple name to recognize this alarm'})>

populate_from_timespec(timespec)

submit = <UnboundField(SubmitField, ('Submit',), {})>

validate_cron_format(field)

larigira.timegen module

main module to read and get informations about alarms

larigira.timegen.check_spec(spec)

larigira.timegen.get_parser()

larigira.timegen.get_timegenerator(kind)

Messes with entrypoints to return an timegenerator function

larigira.timegen.main()

Main function for the “larigira-timegen” executable

larigira.timegen.read_spec(fname)

larigira.timegen.timegenerate(spec, now=None, howmany=1)

larigira.timegen_cron module

class larigira.timegen_cron.CronAlarm(obj)

Bases: AlarmWithExclusions

description = 'Frequency specified by cron-like format. nerds preferred'

do_next_rings(current_time)

larigira.timegen_every module

class larigira.timegen_every.Alarm(obj)

Bases: object

all_rings(current_time=None)

all future rings this, of course, is an iterator (they could be infinite)

has_ring(current_time=None)

returns True IFF the alarm will ring exactly at time

next_ring(current_time=None)

if current_time is None, it is now()

returns the next time it will ring; or None if it will not anymore

class larigira.timegen_every.AlarmWithExclusions(obj)

Bases: Alarm

is_excluded(dt)

next_ring(current_time=None)

if current_time is None, it is now()

returns the next time it will ring; or None if it will not anymore

class larigira.timegen_every.FrequencyAlarm(obj)

Bases: AlarmWithExclusions

rings on {t | exists a k integer >= 0 s.t. t = start+k*t, start<t<end}

description = 'Events at a specified frequency. Example: every 30minutes'

do_next_rings(current_time)

class larigira.timegen_every.SingleAlarm(obj)

Bases: Alarm

rings a single time

description = 'Only once, at a specified date and time'

next_ring(current_time=None)

if current_time is None, it is now()

larigira.timegen_every.getdate(val)

larigira.timegen_exclusions module

class larigira.timegen_exclusions.BaseExclusion

Bases: object

PATTERN = None

classmethod is_valid(line: str)

class larigira.timegen_exclusions.CronExclusion(line: str)

Bases: object

classmethod is_valid(line: str)

matches(dt: datetime)

class larigira.timegen_exclusions.DateExclusion(line: str)

Bases: BaseExclusion

PATTERN = re.compile('^\\d\\d\\d\\d-\\d\\d-\\d\\d$')

matches(dt: datetime)

class larigira.timegen_exclusions.DateTimeExclusion(line: str)

Bases: BaseExclusion

NUMBER = re.compile('\\d+')

PATTERN = re.compile('^\\d\\d\\d\\d-\\d\\d-\\d\\dT\\d\\d:\\d\\d:\\d\\d$')

matches(dt: datetime)

larigira.timegen_exclusions.multi_exclusion(line: str, exclusions=[<class 'larigira.timegen_exclusions.DateTimeExclusion'>, <class 'larigira.timegen_exclusions.DateExclusion'>, <class 'larigira.timegen_exclusions.CronExclusion'>]) → BaseExclusion | None

larigira.unused module

This component will look for files to be removed. There are some assumptions:

• Only files in $TMPDIR are removed. Please remember that larigira has its own specific TMPDIR

• MPD URIs are parsed, and only file:/// is supported

class larigira.unused.UnusedCleaner(conf)

Bases: object

ONLY_DELETE_OLDER_THAN = 30

check_playlist()

check playlist + internal watchlist to see what can be removed

watch(uri)

adds fpath to the list of “watched” file

as soon as it leaves the mpc playlist, it is removed

larigira.unused.old_commonpath(directories)

Module contents