salmon.utils module

Mostly utility functions Salmon uses internally that don’t really belong anywhere else in the modules. This module is kind of a dumping ground, so if you find something that can be improved feel free to work up a patch.

salmon.utils.check_for_pid(pid, force)

Checks if a pid file is there, and if it is sys.exit. If force given then it will remove the file and not exit if it’s there.

salmon.utils.daemonize(pid, chdir, chroot, umask, files_preserve=None, do_open=True)

Uses python-daemonize to do all the junk needed to make a server a server. It supports all the features daemonize has, except that chroot probably won’t work at all without some serious configuration on the system.

salmon.utils.drop_priv(uid, gid)

Changes the uid/gid to the two given, you should give utils.daemonize 0,0 for the uid,gid so that it becomes root, which will allow you to then do this.

salmon.utils.import_settings(boot_also, boot_module='config.boot')

Returns the current settings module, there is no harm in calling it multiple times

The location of the settings module can be control via SALMON_SETTINGS_MODULE

salmon.utils.make_fake_settings(host, port)

When running as a logging server we need a fake settings module to work with since the logging server can be run in any directory, so there may not be a settings module to import.

salmon.utils.start_server(pid, force, chroot, chdir, uid, gid, umask, settings_loader, debug, daemon_proc)

Starts the server by doing a daemonize and then dropping priv accordingly. It will only drop to the uid/gid given if both are given.