Refactor fileservertasks into top level module

This change moves the fileservertasks module to the top level to allow
keeping the same task names when running in a Python 3 environment.
This commit is contained in:
Jan Dittberner 2020-03-04 16:53:50 +01:00
parent cbd8e37e8e
commit 26aae0173d
9 changed files with 118 additions and 109 deletions

View file

@ -1,6 +1,8 @@
Changelog
=========
* :support:`-` move fileservertasks to top level to keep the task names when
using Python 3
* :support:`2` use Pipenv for dependency management
* :release:`0.5.0 <2015-01-29>`

View file

@ -7,32 +7,26 @@ gvafile is implemented as a set of `Celery`_ tasks.
.. _Celery: http://www.celeryproject.org/
The project module :py:mod:`gvafile`
====================================
.. automodule:: gvafile
:py:mod:`celery <gvafile.celery>`
---------------------------------
.. automodule:: gvafile.celery
:members:
:py:mod:`settings <gvafile.settings>`
-------------------------------------
.. automodule:: gvafile.settings
:members:
:py:mod:`fileservertasks` module
================================
.. automodule:: fileservertasks
:py:mod:`celery <fileservertasks.celery>`
-----------------------------------------
.. automodule:: fileservertasks.celery
:members:
:py:mod:`settings <fileservertasks.settings>`
---------------------------------------------
.. automodule:: fileservertasks.settings
:members:
:py:mod:`tasks <fileservertasks.tasks>`
---------------------------------------

View file

@ -18,12 +18,15 @@ import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath(os.path.join('..', 'gvafile')))
sys.path.insert(0, os.path.abspath(os.path.join("..", "gvafile")))
os.environ['GVAFILE_ALLOWED_HOSTS'] = 'localhost'
os.environ['GVAFILE_SERVER_EMAIL'] = 'root@localhost'
os.environ['GVAFILE_SFTP_DIRECTORY'] = '/home/www'
os.environ['GVAFILE_MAIL_DIRECTORY'] = '/home/mail'
os.environ["GVAFILE_BROKER_URL"] = "amqp://"
os.environ["GVAFILE_ALLOWED_HOSTS"] = "localhost"
os.environ["GVAFILE_MAIL_DIRECTORY"] = "/home/mail"
os.environ["GVAFILE_RESULTS_REDIS_URL"] = "redis://"
os.environ["GVAFILE_SERVER_EMAIL"] = "root@localhost"
os.environ["GVAFILE_SFTP_AUTHKEYS_DIRECTORY"] = "/srv/sftp/authorized_keys"
os.environ["GVAFILE_SFTP_DIRECTORY"] = "/home/www"
# -- General configuration -----------------------------------------------------
@ -32,36 +35,37 @@ os.environ['GVAFILE_MAIL_DIRECTORY'] = '/home/mail'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['releases', 'sphinx.ext.autodoc', 'celery.contrib.sphinx']
extensions = ["releases", "sphinx.ext.autodoc", "celery.contrib.sphinx"]
# configuration for releases extension
releases_issue_uri = "https://git.dittberner.info/gnuviech/gvafile/issues/%s"
releases_release_uri = "https://git.dittberner.info/gnuviech/gvafile/src/tag/%s"
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
releases_issue_uri = 'https://dev.gnuviech-server.de/gvafile/ticket/%s'
releases_release_uri = 'https://dev.gnuviech-server.de/gvafile/milestone/%s'
templates_path = ["_templates"]
# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = ".rst"
# The encoding of source files.
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
master_doc = "index"
# General information about the project.
project = u'gvafile'
copyright = u'2014, 2015 Jan Dittberner'
project = u"gvafile"
copyright = u"2014-2020, Jan Dittberner"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.5'
# The full version, including alpha/beta/rc tags.
release = '0.5.0'
from fileservertasks import __version__ as release
# The short X.Y version.
version = ".".join(release.split(".")[:2])
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -75,7 +79,7 @@ release = '0.5.0'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
exclude_patterns = ["_build"]
# The reST default role (used for this markup: `text`) to use for all documents.
# default_role = None
@ -92,7 +96,7 @@ exclude_patterns = ['_build']
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
@ -102,7 +106,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = "alabaster"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@ -131,7 +135,7 @@ html_theme = 'default'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ["_static"]
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
@ -175,7 +179,7 @@ html_static_path = ['_static']
# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'gvafiledoc'
htmlhelp_basename = "gvafiledoc"
# -- Options for LaTeX output --------------------------------------------------
@ -183,10 +187,8 @@ htmlhelp_basename = 'gvafiledoc'
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
@ -194,8 +196,7 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'gvafile.tex', u'gvafile Documentation',
u'Jan Dittberner', 'manual'),
("index", "gvafile.tex", u"gvafile Documentation", u"Jan Dittberner", "manual")
]
# The name of an image file (relative to this directory) to place at the top of
@ -223,10 +224,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'gvafile', u'gvafile Documentation',
[u'Jan Dittberner'], 1)
]
man_pages = [("index", "gvafile", u"gvafile Documentation", [u"Jan Dittberner"], 1)]
# If true, show URL addresses after external links.
# man_show_urls = False
@ -238,9 +236,15 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'gvafile', u'gvafile Documentation',
u'Jan Dittberner', 'gvafile', 'GNUViech admin fileserver tools.',
'Miscellaneous'),
(
"index",
"gvafile",
u"gvafile Documentation",
u"Jan Dittberner",
"gvafile",
"GNUViech admin fileserver tools.",
"Miscellaneous",
)
]
# Documents to append as an appendix to all manuals.

View file

@ -2,3 +2,8 @@
This module contains :py:mod:`fileservertasks.tasks`.
"""
__version__ = "0.6.0"
from fileservertasks.celery import app as celery_app
__all__ = ('celery_app',)

View file

@ -9,7 +9,7 @@ from __future__ import absolute_import
from celery import Celery
#: The Celery application
app = Celery('gvafile')
app = Celery('fileservertasks')
app.config_from_object('gvafile.settings')
app.autodiscover_tasks(['fileservertasks'], force=True)
app.config_from_object('fileservertasks.settings')
app.autodiscover_tasks(['fileservertasks.tasks'], force=True)

View file

@ -25,23 +25,20 @@ def get_env_variable(setting):
########## CELERY CONFIGURATION
CELERY_TIMEZONE = 'Europe/Berlin'
CELERY_TIMEZONE = "Europe/Berlin"
CELERY_ENABLE_UTC = True
CELERY_RESULT_BACKEND = get_env_variable('GVAFILE_RESULTS_REDIS_URL')
CELERY_RESULT_BACKEND = get_env_variable("GVAFILE_RESULTS_REDIS_URL")
CELERY_RESULT_PERSISTENT = True
CELERY_TASK_RESULT_EXPIRES = None
CELERY_ROUTES = (
'gvacommon.celeryrouters.GvaRouter',
)
CELERY_ACCEPT_CONTENT = ['json']
CELERY_TASK_SERIALIZER = 'json'
CELERY_RESULT_SERIALIZER = 'json'
BROKER_URL = get_env_variable('GVAFILE_BROKER_URL')
CELERY_ROUTES = ("gvacommon.celeryrouters.GvaRouter",)
CELERY_ACCEPT_CONTENT = ["json"]
CELERY_TASK_SERIALIZER = "json"
CELERY_RESULT_SERIALIZER = "json"
BROKER_URL = get_env_variable("GVAFILE_BROKER_URL")
########## END CELERY CONFIGURATION
########## GVAFILE CONFIGURATION
GVAFILE_SFTP_DIRECTORY = get_env_variable('GVAFILE_SFTP_DIRECTORY')
GVAFILE_MAIL_DIRECTORY = get_env_variable('GVAFILE_MAIL_DIRECTORY')
GVAFILE_SFTP_AUTHKEYS_DIRECTORY = get_env_variable(
'GVAFILE_SFTP_AUTHKEYS_DIRECTORY')
GVAFILE_SFTP_DIRECTORY = get_env_variable("GVAFILE_SFTP_DIRECTORY")
GVAFILE_MAIL_DIRECTORY = get_env_variable("GVAFILE_MAIL_DIRECTORY")
GVAFILE_SFTP_AUTHKEYS_DIRECTORY = get_env_variable("GVAFILE_SFTP_AUTHKEYS_DIRECTORY")
########## END GVAFILE CONFIGURATION

View file

@ -11,7 +11,7 @@ import os
import subprocess
from tempfile import mkstemp
from gvafile import settings
from fileservertasks import settings
from celery import shared_task
from celery.utils.log import get_task_logger

View file

@ -0,0 +1,7 @@
# -*- coding: utf-8 -*-
class GvaRouter(object):
def route_for_task(self, task, args=None, kwargs=None):
for route in ["ldap", "file", "mysql", "pgsql", "web"]:
if route in task:
return {"exchange": route, "exchange_type": "direct", "queue": route}
return None