Fix: run pre-commit hooks

Makefile

@@ -9,4 +9,3 @@ docker-build-usecase:
 
 docker-usecase: docker-build-usecase
 	docker run usecase sh -c "bopytex -s students.csv tpl_example.tex && cat 1_example.tex"
-

bopytex/default_config.py

@@ -1,3 +1,4 @@
+from bopytex.jinja2_env.texenv import texenv
 from bopytex.planner.generate_compile_join_planner import planner
 from bopytex.worker import Dispatcher
 from bopytex.worker.activate_corr import activate_corr
@@ -5,22 +6,20 @@ from bopytex.worker.clean import clean
 from bopytex.worker.compile import pdflatex
 from bopytex.worker.generate import generate
 from bopytex.worker.join_pdf import pdfjam
-from bopytex.jinja2_env.texenv import texenv
 
-jinja2 = {
-    "environment": texenv
-}
+jinja2 = {"environment": texenv}
 
-dispatcher = Dispatcher({
+dispatcher = Dispatcher(
+    {
         "GENERATE": generate,
         "COMPILE": pdflatex,
         "JOIN": pdfjam,
         "CLEAN": clean,
         "ACTIVATE_CORR": activate_corr,
-    })
+    }
+)
 
 latex = {
     "solution": r"solution/print = true",
     "no_solution": r"solution/print = false",
 }
-

bopytex/message.py

@@ -1,4 +1,4 @@
-class Message():
+class Message:
     def __init__(self, status, out, err):
         self._status = status
         self._out = out
@@ -19,6 +19,7 @@ class Message():
     def __repr__(self):
         return f"Message(status={self.status}, out={self.out}, err={self.err})"
 
+
 class SubprocessMessage(Message):
     def __init__(self, process):
         self._process = process

bopytex/planner/activate_corr_compile_join_planner.py

@@ -1,7 +1,8 @@
-from bopytex.tasks import Task, activate_corr_on, compile_pdf, join_pdfs
-import bopytex.planner.naming as naming
 import os
 
+import bopytex.planner.naming as naming
+from bopytex.tasks import Task, activate_corr_on, compile_pdf, join_pdfs
+
 
 def list_files(dir=".", accept=lambda _: True, reject=lambda _: False):
     files = []

bopytex/planner/generate_compile_join_planner.py

@@ -1,7 +1,8 @@
-from bopytex.tasks import Task, activate_corr_on, compile_pdf, generate, join_pdfs
+import csv
+
 import bopytex.planner.naming as naming
 from bopytex.planner.exceptions import PlannerMissingOption
-import csv
+from bopytex.tasks import Task, activate_corr_on, compile_pdf, generate, join_pdfs
 
 
 def build_subject_list_from_infos(infos: list[dict]) -> list[dict]:
@@ -70,10 +71,7 @@ def tasks_builder(
 
     for subject in subjects:
         source = naming.template2source(template, subject)
-        args = {
-                "subject": subject, 
-                "options": options
-                }
+        args = {"subject": subject, "options": options}
 
         tasks.append(generate(template, args, source))
 

bopytex/planner/naming.py

@@ -12,4 +12,3 @@ def source2pdf(source):
 
 def join(template):
     return source2pdf("joined" + template[3:])
-

bopytex/script.py

@@ -2,9 +2,10 @@
 # encoding: utf-8
 
 
-import click
 import logging
 
+import click
+
 from bopytex.service import main
 
 formatter = logging.Formatter("%(name)s :: %(levelname)s :: %(message)s")

bopytex/service.py

@@ -8,8 +8,9 @@ Producing then compiling templates
 import importlib.util
 import os
 from pathlib import Path
-from bopytex.scheduler import Scheduler
+
 from bopytex import default_config
+from bopytex.scheduler import Scheduler
 
 
 def orcherstrator(

bopytex/worker/__init__.py

@@ -15,4 +15,3 @@ class Dispatcher:
             )
 
         return choosen_action(args=task.args, deps=task.deps, output=task.output)
-

bopytex/worker/activate_corr.py

@@ -11,4 +11,3 @@ def activate_corr(args, deps, output):
                 output_f.write(line.replace(no_solution, solution))
 
     return Message(0, [f"ACTIVATE CORR - {deps[0]} to {output}"], [])
-

bopytex/worker/compile.py

@@ -1,6 +1,7 @@
 import subprocess
 
 from bopytex.message import Message
+
 from ..message import SubprocessMessage
 
 

bopytex/worker/join_pdf.py

@@ -20,8 +20,7 @@ def pdfjam(args: dict, deps, output):
 def gs(args: dict, deps, output):
     """Not working. The command works in terminal but not here"""
     joining_process = subprocess.Popen(
-        ["gs", f"-dBATCH -dNOPAUSE -q -sDEVICE=pdfwrite -sOutputFile={output}"]
-        + deps,
+        ["gs", f"-dBATCH -dNOPAUSE -q -sDEVICE=pdfwrite -sOutputFile={output}"] + deps,
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,
         universal_newlines=True,

documentation/Makefile

@@ -198,5 +198,3 @@ SSH_TARGET_DIR=/var/docker/opytex.org/www/opytex
 
 rsync_upload: html
 	rsync -e "ssh" -P -rvzc --delete $(BUILDDIR)/html/ $(SSH_CONF):$(SSH_TARGET_DIR) --cvs-exclude
-
-

documentation/source/_downloads/tpl_DM.tex

@@ -188,4 +188,3 @@ Calculer les longueurs $OC$ et $AB$.
 %%% mode: latex
 %%% TeX-master: "master"
 %%% End:
-

documentation/source/conf.py

@@ -13,9 +13,9 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
 import os
 import shlex
+import sys
 
 # 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
@@ -31,46 +31,46 @@ import shlex
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.ifconfig',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.viewcode",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 # source_suffix = ['.rst', '.md']
-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 = 'Opytex'
-copyright = '2016, Benjamin Bertrand'
-author = 'Benjamin Bertrand'
+project = "Opytex"
+copyright = "2016, Benjamin Bertrand"
+author = "Benjamin Bertrand"
 
 # 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.1'
+version = "0.1"
 # The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = "0.1"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = 'fr'
+language = "fr"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -98,7 +98,7 @@ exclude_patterns = []
 # 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 = []
@@ -116,6 +116,7 @@ todo_include_todos = False
 # a list of builtin themes.
 # html_theme = 'alabaster'
 import sphinx_rtd_theme
+
 html_theme = "sphinx_rtd_theme"
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
@@ -146,7 +147,7 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 # 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"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -209,20 +210,17 @@ html_static_path = ['_static']
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Opytexdoc'
+htmlhelp_basename = "Opytexdoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 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': '',
-
     # Latex figure (float) alignment
     #'figure_align': 'htbp',
 }
@@ -231,8 +229,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  (master_doc, 'Opytex.tex', 'Opytex Documentation',
-   'Benjamin Bertrand', 'manual'),
+    (master_doc, "Opytex.tex", "Opytex Documentation", "Benjamin Bertrand", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -260,10 +257,7 @@ latex_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'opytex', 'Opytex Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "opytex", "Opytex Documentation", [author], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -275,9 +269,15 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  (master_doc, 'Opytex', 'Opytex Documentation',
-   author, 'Opytex', 'One line description of project.',
-   'Miscellaneous'),
+    (
+        master_doc,
+        "Opytex",
+        "Opytex Documentation",
+        author,
+        "Opytex",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.

documentation/source/index.rst

@@ -38,4 +38,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

documentation/source/tutorial.rst

@@ -158,6 +158,3 @@ Il est possible aussi de créer les sujets et les corrections en même temps ave
     .. code-block:: bash
 
         opytex -t tpl_DM.tex -c -N 60
-
-
-    

example/usecase/bopytex_config.py

@@ -1,4 +1,3 @@
 from mapytex import Expression
-direct_access = {
-        "Expression": Expression
-        }
+
+direct_access = {"Expression": Expression}

test/fakes/dispatcher.py

@@ -1,5 +1,6 @@
 from bopytex.worker import Dispatcher
-from .workers import fake_worker, success_worker, fail_worker
+
+from .workers import fail_worker, fake_worker, success_worker
 
 fake_dispatcher = Dispatcher(
     {

test/fakes/workers.py

@@ -1,5 +1,6 @@
 from bopytex.message import Message
 
+
 def fake_worker(args, deps, output):
     return Message(0, [f"FAKE - {args} - {deps} - {output}"], [])
 
@@ -10,4 +11,3 @@ def success_worker(args, deps, output):
 
 def fail_worker(args, deps, output):
     return Message(1, [f"FAILURE - {args} - {deps} - {output}"], [])
-

test/test_e2e.py

@@ -1,9 +1,11 @@
 import os
-import jinja2
 from pathlib import Path
-from bopytex.service import main
+
+import jinja2
 import pytest
 
+from bopytex.service import main
+
 
 @pytest.fixture
 def template_path(tmp_path):
@@ -22,6 +24,7 @@ Subject {{ number }}
         )
     return template
 
+
 @pytest.fixture
 def bad_template_path(tmp_path):
     template = tmp_path / "tpl_source.tex"
@@ -64,6 +67,7 @@ def test_with_default_planner(template_path, jinja2_env, tmp_path):
 
     assert Path("joined_source.pdf").exists()
 
+
 def test_with_default_planner_bad_template(bad_template_path, jinja2_env, tmp_path):
     os.chdir(tmp_path)
 
@@ -82,4 +86,3 @@ def test_with_default_planner_bad_template(bad_template_path, jinja2_env, tmp_pa
         pass
 
     assert not Path("joined_source.pdf").exists()
-

test/test_planner.py

@@ -1,5 +1,9 @@
-from bopytex.planner.generate_compile_join_planner import tasks_builder as gcj_task_builder
-from bopytex.planner.activate_corr_compile_join_planner import tasks_builder as accj_task_builder
+from bopytex.planner.activate_corr_compile_join_planner import (
+    tasks_builder as accj_task_builder,
+)
+from bopytex.planner.generate_compile_join_planner import (
+    tasks_builder as gcj_task_builder,
+)
 from bopytex.tasks import Task
 
 
@@ -18,9 +22,9 @@ def test_tasks_builder_generate():
                 "options": {
                     "no_pdf": True,
                     "subjects": [{"number": "01"}, {"number": "02"}],
-                    'template': 'tpl_source.tex',
+                    "template": "tpl_source.tex",
                 },
-                "subject": {"number": "01"}
+                "subject": {"number": "01"},
             },
             deps=["tpl_source.tex"],
             output="01_source.tex",
@@ -31,9 +35,9 @@ def test_tasks_builder_generate():
                 "options": {
                     "no_pdf": True,
                     "subjects": [{"number": "01"}, {"number": "02"}],
-                    'template': 'tpl_source.tex',
+                    "template": "tpl_source.tex",
                 },
-                "subject": {"number": "02"}
+                "subject": {"number": "02"},
             },
             deps=["tpl_source.tex"],
             output="02_source.tex",
@@ -56,9 +60,9 @@ def test_tasks_builder_generate_compile():
                 "options": {
                     "no_join": True,
                     "subjects": [{"number": "01"}, {"number": "02"}],
-                    'template': 'tpl_source.tex',
+                    "template": "tpl_source.tex",
                 },
-                "subject": {"number": "01"}
+                "subject": {"number": "01"},
             },
             deps=["tpl_source.tex"],
             output="01_source.tex",
@@ -75,9 +79,9 @@ def test_tasks_builder_generate_compile():
                 "options": {
                     "no_join": True,
                     "subjects": [{"number": "01"}, {"number": "02"}],
-                    'template': 'tpl_source.tex',
+                    "template": "tpl_source.tex",
                 },
-                "subject": {"number": "02"}
+                "subject": {"number": "02"},
             },
             deps=["tpl_source.tex"],
             output="02_source.tex",
@@ -104,9 +108,9 @@ def test_tasks_builder_generate_compile_join():
             args={
                 "options": {
                     "subjects": [{"number": "01"}, {"number": "02"}],
-                    'template': 'tpl_source.tex',
+                    "template": "tpl_source.tex",
                 },
-                "subject": {"number": "01"}
+                "subject": {"number": "01"},
             },
             deps=["tpl_source.tex"],
             output="01_source.tex",
@@ -122,9 +126,9 @@ def test_tasks_builder_generate_compile_join():
             args={
                 "options": {
                     "subjects": [{"number": "01"}, {"number": "02"}],
-                    'template': 'tpl_source.tex',
+                    "template": "tpl_source.tex",
                 },
-                "subject": {"number": "02"}
+                "subject": {"number": "02"},
             },
             deps=["tpl_source.tex"],
             output="02_source.tex",
@@ -161,9 +165,9 @@ def test_tasks_builder_generate_compile_corr():
                     "subjects": [{"number": "01"}, {"number": "02"}],
                     "corr": True,
                     "no_join": True,
-                    'template': 'tpl_source.tex',
+                    "template": "tpl_source.tex",
                 },
-                "subject": {"number": "01"}
+                "subject": {"number": "01"},
             },
             deps=["tpl_source.tex"],
             output="01_source.tex",
@@ -177,11 +181,11 @@ def test_tasks_builder_generate_compile_corr():
         Task(
             action="ACTIVATE_CORR",
             args={
-                'corr': True,
-                'no_join': True,
-                'no_pdf': False,
-                'template': 'tpl_source.tex',
-                "subjects": [{'number': '01'}, {'number': '02'}]
+                "corr": True,
+                "no_join": True,
+                "no_pdf": False,
+                "template": "tpl_source.tex",
+                "subjects": [{"number": "01"}, {"number": "02"}],
             },
             deps=["01_source.tex"],
             output="corr_01_source.tex",
@@ -199,9 +203,9 @@ def test_tasks_builder_generate_compile_corr():
                     "subjects": [{"number": "01"}, {"number": "02"}],
                     "corr": True,
                     "no_join": True,
-                    'template': 'tpl_source.tex',
+                    "template": "tpl_source.tex",
                 },
-                "subject": {"number": "02"}
+                "subject": {"number": "02"},
             },
             deps=["tpl_source.tex"],
             output="02_source.tex",
@@ -215,11 +219,11 @@ def test_tasks_builder_generate_compile_corr():
         Task(
             action="ACTIVATE_CORR",
             args={
-                'corr': True,
-                'no_join': True,
-                'no_pdf': False,
-                'template': 'tpl_source.tex',
-                "subjects": [{'number': '01'}, {'number': '02'}]
+                "corr": True,
+                "no_join": True,
+                "no_pdf": False,
+                "template": "tpl_source.tex",
+                "subjects": [{"number": "01"}, {"number": "02"}],
             },
             deps=["02_source.tex"],
             output="corr_02_source.tex",
@@ -250,9 +254,9 @@ def test_tasks_builder_generate_compile_corr_joined():
                     "subjects": [{"number": "01"}, {"number": "02"}],
                     "corr": True,
                     "no_join": False,
-                    'template': 'tpl_source.tex',
+                    "template": "tpl_source.tex",
                 },
-                "subject": {"number": "01"}
+                "subject": {"number": "01"},
             },
             deps=["tpl_source.tex"],
             output="01_source.tex",
@@ -266,11 +270,11 @@ def test_tasks_builder_generate_compile_corr_joined():
         Task(
             action="ACTIVATE_CORR",
             args={
-                'corr': True,
-                'no_join': False,
-                'no_pdf': False,
-                'template': 'tpl_source.tex',
-                "subjects": [{'number': '01'}, {'number': '02'}]
+                "corr": True,
+                "no_join": False,
+                "no_pdf": False,
+                "template": "tpl_source.tex",
+                "subjects": [{"number": "01"}, {"number": "02"}],
             },
             deps=["01_source.tex"],
             output="corr_01_source.tex",
@@ -288,9 +292,9 @@ def test_tasks_builder_generate_compile_corr_joined():
                     "subjects": [{"number": "01"}, {"number": "02"}],
                     "corr": True,
                     "no_join": False,
-                    'template': 'tpl_source.tex',
+                    "template": "tpl_source.tex",
                 },
-                "subject": {"number": "02"}
+                "subject": {"number": "02"},
             },
             deps=["tpl_source.tex"],
             output="02_source.tex",
@@ -304,11 +308,11 @@ def test_tasks_builder_generate_compile_corr_joined():
         Task(
             action="ACTIVATE_CORR",
             args={
-                'corr': True,
-                'no_join': False,
-                'no_pdf': False,
-                'template': 'tpl_source.tex',
-                "subjects": [{'number': '01'}, {'number': '02'}]
+                "corr": True,
+                "no_join": False,
+                "no_pdf": False,
+                "template": "tpl_source.tex",
+                "subjects": [{"number": "01"}, {"number": "02"}],
             },
             deps=["02_source.tex"],
             output="corr_02_source.tex",
@@ -344,9 +348,9 @@ def test_only_corr_tasks_builder():
         Task(
             action="ACTIVATE_CORR",
             args={
-                'no_join': False,
-                'no_pdf': False,
-                'sources': ['01_source.tex', '02_source.tex']
+                "no_join": False,
+                "no_pdf": False,
+                "sources": ["01_source.tex", "02_source.tex"],
             },
             deps=["01_source.tex"],
             output="corr_01_source.tex",
@@ -360,9 +364,9 @@ def test_only_corr_tasks_builder():
         Task(
             action="ACTIVATE_CORR",
             args={
-                'no_join': False,
-                'no_pdf': False,
-                'sources': ['01_source.tex', '02_source.tex']
+                "no_join": False,
+                "no_pdf": False,
+                "sources": ["01_source.tex", "02_source.tex"],
             },
             deps=["02_source.tex"],
             output="corr_02_source.tex",

test/test_scheduler.py

@@ -1,9 +1,11 @@
-from bopytex.message import Message
-from bopytex.tasks import Task
-from bopytex.scheduler import Scheduler
-from .fakes.dispatcher import fake_dispatcher
 import pytest
 
+from bopytex.message import Message
+from bopytex.scheduler import Scheduler
+from bopytex.tasks import Task
+
+from .fakes.dispatcher import fake_dispatcher
+
 
 def test_schedule_append():
     scheduler = Scheduler(dispatcher=fake_dispatcher)

test/test_service.py

@@ -1,10 +1,12 @@
 import os
+
 import pytest
 
 from bopytex.planner import fake_planner
 from bopytex.service import build_config, orcherstrator
 from bopytex.tasks import Task
 from bopytex.worker import Dispatcher
+
 from .fakes.workers import fake_worker
 
 

test/test_texenv.py

@@ -22,6 +22,7 @@ def test_block_line_statement():
     output = jinja2_template.render()
     assert output == "2"
 
+
 def test_block_line_statement_with_comment():
     base_template = r"""%-set a = 2
 %# comment
@@ -30,11 +31,10 @@ def test_block_line_statement_with_comment():
     output = jinja2_template.render()
     assert output == "\n2"
 
+
 def test_add_filter():
     texenv.filters["count_caracters"] = lambda x: len(x)
     base_template = r"""\Var{a} has \Var{a | count_caracters}"""
     jinja2_template = texenv.from_string(base_template)
     output = jinja2_template.render(a="coucou")
     assert output == "coucou has 6"
-    
-

test/worker/test_compile.py

@@ -1,9 +1,10 @@
 import os
-
 from pathlib import Path
-from bopytex.worker.compile import latexmk
+
 import pytest
 
+from bopytex.worker.compile import latexmk
+
 
 @pytest.fixture
 def tex_path(tmp_path):

test/worker/test_generate.py

@@ -1,8 +1,10 @@
 import os
+
 import jinja2
-from bopytex.worker.generate import generate
 import pytest
 
+from bopytex.worker.generate import generate
+
 
 @pytest.fixture
 def jinja2_env(tmp_path):
@@ -70,7 +72,7 @@ def test_generate_with_random(template_path_with_random, jinja2_env):
                 "jinja2": {"environment": jinja2_env},
                 "direct_access": {
                     "random": random,
-                    }
+                },
             },
             "subject": {},
         },

test/worker/test_join_pdf.py

@@ -1,10 +1,11 @@
 import os
-
 import shutil
 from pathlib import Path
-from bopytex.worker.join_pdf import pdfjam
+
 import pytest
 
+from bopytex.worker.join_pdf import pdfjam
+
 
 @pytest.fixture
 def multiple_pdf(tmp_path, request):