Merge pull request #31 from dabapps/black

Add and run black

Author: jordaneb

.travis.yml

@@ -16,7 +16,10 @@ env:
 install:
 - pip install -r test-requirements.txt
 - pip install -U django==$DJANGO_VERSION
-script: python manage.py test
+- if [ "$TRAVIS_PYTHON_VERSION" != "3.5" ]; then pip install black==19.10b0; fi
+script:
+  - if [ "$TRAVIS_PYTHON_VERSION" != "3.5" ]; then black --check django_dbq; fi
+  - python manage.py test
 deploy:
   provider: pypi
   user: dabapps

django_dbq/__init__.py

@@ -1 +1 @@
-__version__ = '1.2.0'
+__version__ = "1.2.0"

django_dbq/management/commands/create_job.py

@@ -11,23 +11,23 @@
 class Command(BaseCommand):
 
     help = "Create a job"
-    args = '<job_name>'
+    args = "<job_name>"
 
     def add_arguments(self, parser):
-        parser.add_argument('args', nargs='+')
+        parser.add_argument("args", nargs="+")
         parser.add_argument(
-            '--workspace',
-            action='store_true',
-            dest='workspace',
+            "--workspace",
+            action="store_true",
+            dest="workspace",
             default=None,
-            help="JSON-formatted initial commandworkspace."
+            help="JSON-formatted initial commandworkspace.",
         )
         parser.add_argument(
-            '--queue_name',
-            action='store_true',
-            dest='queue_name',
+            "--queue_name",
+            action="store_true",
+            dest="queue_name",
             default=None,
-            help="A specific queue to add this job to"
+            help="A specific queue to add this job to",
         )
 
     def handle(self, *args, **options):
@@ -38,19 +38,22 @@ def handle(self, *args, **options):
         if name not in settings.JOBS:
             raise CommandError('"%s" is not a valid job name' % name)
 
-        workspace = options['workspace']
+        workspace = options["workspace"]
         if workspace:
             workspace = json.loads(workspace)
 
-        queue_name = options['queue_name']
+        queue_name = options["queue_name"]
 
         kwargs = {
-            'name': name,
-            'workspace': workspace,
+            "name": name,
+            "workspace": workspace,
         }
 
         if queue_name:
-            kwargs['queue_name'] = queue_name
+            kwargs["queue_name"] = queue_name
 
         job = Job.objects.create(**kwargs)
-        self.stdout.write('Created job: "%s", id=%s for queue "%s"' % (job.name, job.pk, queue_name if queue_name else 'default'))
+        self.stdout.write(
+            'Created job: "%s", id=%s for queue "%s"'
+            % (job.name, job.pk, queue_name if queue_name else "default")
+        )

django_dbq/management/commands/delete_old_jobs.py

@@ -8,4 +8,4 @@ class Command(BaseCommand):
 
     def handle(self, *args, **options):
         Job.objects.delete_old()
-        self.stdout.write('Deleted old jobs')
+        self.stdout.write("Deleted old jobs")

django_dbq/management/commands/worker.py

@@ -11,7 +11,7 @@
 logger = logging.getLogger(__name__)
 
 
-DEFAULT_QUEUE_NAME = 'default'
+DEFAULT_QUEUE_NAME = "default"
 
 
 def process_job(queue_name):
@@ -22,7 +22,14 @@ def process_job(queue_name):
         if not job:
             return
 
-        logger.info('Processing job: name="%s" queue="%s" id=%s state=%s next_task=%s', job.name, queue_name, job.pk, job.state, job.next_task)
+        logger.info(
+            'Processing job: name="%s" queue="%s" id=%s state=%s next_task=%s',
+            job.name,
+            queue_name,
+            job.pk,
+            job.state,
+            job.next_task,
+        )
         job.state = Job.STATES.PROCESSING
         job.save()
 
@@ -40,18 +47,30 @@ def process_job(queue_name):
 
         failure_hook_name = job.get_failure_hook_name()
         if failure_hook_name:
-            logger.info("Running failure hook %s for job id=%s", failure_hook_name, job.pk)
+            logger.info(
+                "Running failure hook %s for job id=%s", failure_hook_name, job.pk
+            )
             failure_hook_function = import_string(failure_hook_name)
             failure_hook_function(job, exception)
         else:
             logger.info("No failure hook for job id=%s", job.pk)
 
-    logger.info('Updating job: name="%s" id=%s state=%s next_task=%s', job.name, job.pk, job.state, job.next_task or 'none')
+    logger.info(
+        'Updating job: name="%s" id=%s state=%s next_task=%s',
+        job.name,
+        job.pk,
+        job.state,
+        job.next_task or "none",
+    )
 
     try:
         job.save()
     except:
-        logger.error('Failed to save job: id=%s org=%s', job.pk, job.workspace.get('organisation_id'))
+        logger.error(
+            "Failed to save job: id=%s org=%s",
+            job.pk,
+            job.workspace.get("organisation_id"),
+        )
         raise
 
 
@@ -67,7 +86,11 @@ def __init__(self, name, rate_limit_in_seconds):
 
     def do_work(self):
         sleep(1)
-        if self.last_job_finished and (timezone.now() - self.last_job_finished).total_seconds() < self.rate_limit_in_seconds:
+        if (
+            self.last_job_finished
+            and (timezone.now() - self.last_job_finished).total_seconds()
+            < self.rate_limit_in_seconds
+        ):
             return
 
         process_job(self.queue_name)
@@ -79,14 +102,20 @@ class Command(BaseCommand):
     help = "Run a queue worker process"
 
     def add_arguments(self, parser):
-        parser.add_argument('queue_name', nargs='?', default='default', type=str)
-        parser.add_argument('rate_limit', help='The rate limit in seconds. The default rate limit is 1 job per second.', nargs='?', default=1, type=int)
+        parser.add_argument("queue_name", nargs="?", default="default", type=str)
         parser.add_argument(
-            '--dry-run',
-            action='store_true',
-            dest='dry_run',
+            "rate_limit",
+            help="The rate limit in seconds. The default rate limit is 1 job per second.",
+            nargs="?",
+            default=1,
+            type=int,
+        )
+        parser.add_argument(
+            "--dry-run",
+            action="store_true",
+            dest="dry_run",
             default=False,
-            help="Don't actually start the worker. Used for testing."
+            help="Don't actually start the worker. Used for testing.",
         )
 
     def handle(self, *args, **options):
@@ -96,14 +125,17 @@ def handle(self, *args, **options):
         if len(args) != 1:
             raise CommandError("Please supply a single queue job name")
 
-        queue_name = options['queue_name']
-        rate_limit_in_seconds = options['rate_limit']
+        queue_name = options["queue_name"]
+        rate_limit_in_seconds = options["rate_limit"]
 
-        self.stdout.write("Starting job worker for queue \"%s\" with rate limit %s/s" % (queue_name, rate_limit_in_seconds))
+        self.stdout.write(
+            'Starting job worker for queue "%s" with rate limit %s/s'
+            % (queue_name, rate_limit_in_seconds)
+        )
 
         worker = Worker(queue_name, rate_limit_in_seconds)
 
-        if options['dry_run']:
+        if options["dry_run"]:
             return
 
         worker.run()

django_dbq/migrations/0001_initial.py

@@ -10,24 +10,46 @@
 
 class Migration(migrations.Migration):
 
-    dependencies = [
-    ]
+    dependencies = []
 
     operations = [
         migrations.CreateModel(
-            name='Job',
+            name="Job",
             fields=[
-                ('id', UUIDField(serialize=False, editable=False, default=uuid.uuid4, primary_key=True)),
-                ('created', models.DateTimeField(db_index=True, auto_now_add=True)),
-                ('modified', models.DateTimeField(auto_now=True)),
-                ('name', models.CharField(max_length=100)),
-                ('state', models.CharField(db_index=True, max_length=20, default='NEW', choices=[('NEW', 'NEW'), ('READY', 'READY'), ('PROCESSING', 'PROCESSING'), ('FAILED', 'FAILED'), ('COMPLETE', 'COMPLETE')])),
-                ('next_task', models.CharField(max_length=100, blank=True)),
-                ('workspace', jsonfield.fields.JSONField(null=True)),
-                ('queue_name', models.CharField(db_index=True, max_length=20, default='default')),
+                (
+                    "id",
+                    UUIDField(
+                        serialize=False,
+                        editable=False,
+                        default=uuid.uuid4,
+                        primary_key=True,
+                    ),
+                ),
+                ("created", models.DateTimeField(db_index=True, auto_now_add=True)),
+                ("modified", models.DateTimeField(auto_now=True)),
+                ("name", models.CharField(max_length=100)),
+                (
+                    "state",
+                    models.CharField(
+                        db_index=True,
+                        max_length=20,
+                        default="NEW",
+                        choices=[
+                            ("NEW", "NEW"),
+                            ("READY", "READY"),
+                            ("PROCESSING", "PROCESSING"),
+                            ("FAILED", "FAILED"),
+                            ("COMPLETE", "COMPLETE"),
+                        ],
+                    ),
+                ),
+                ("next_task", models.CharField(max_length=100, blank=True)),
+                ("workspace", jsonfield.fields.JSONField(null=True)),
+                (
+                    "queue_name",
+                    models.CharField(db_index=True, max_length=20, default="default"),
+                ),
             ],
-            options={
-                'ordering': ['-created'],
-            },
+            options={"ordering": ["-created"],},
         ),
     ]

django_dbq/migrations/0002_auto_20151016_1027.py

@@ -7,12 +7,9 @@
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('django_dbq', '0001_initial'),
+        ("django_dbq", "0001_initial"),
     ]
 
     operations = [
-        migrations.AlterModelOptions(
-            name='job',
-            options={'ordering': ['created']},
-        ),
+        migrations.AlterModelOptions(name="job", options={"ordering": ["created"]},),
     ]

django_dbq/migrations/0003_auto_20180713_1000.py

@@ -8,17 +8,16 @@
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('django_dbq', '0002_auto_20151016_1027'),
+        ("django_dbq", "0002_auto_20151016_1027"),
     ]
 
     operations = [
         migrations.AlterModelOptions(
-            name='job',
-            options={'ordering': ['-priority', 'created']},
+            name="job", options={"ordering": ["-priority", "created"]},
         ),
         migrations.AddField(
-            model_name='job',
-            name='priority',
+            model_name="job",
+            name="priority",
             field=models.SmallIntegerField(db_index=True, default=0),
         ),
     ]