From 2f98a64cdd3c9eb7db9b6d93059e34458978955b Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Fri, 21 Jun 2019 10:05:40 -0500 Subject: [PATCH 01/21] version bumps and migration to django 2.2 --- .../migrations/0002_auto_20150619_1124.py | 2 +- .../migrations/0003_auto_20150619_1637.py | 2 +- dispatch/models.py | 2 +- dr_botzo/settings.py | 5 +- dr_botzo/urls.py | 2 +- facts/migrations/0001_initial.py | 2 +- facts/models.py | 2 +- gitlab_bot/migrations/0001_initial.py | 2 +- gitlab_bot/models.py | 2 +- ircbot/migrations/0009_botadmin_user.py | 2 +- ircbot/models.py | 2 +- karma/migrations/0001_initial.py | 2 +- karma/models.py | 2 +- markov/migrations/0001_initial.py | 4 +- markov/models.py | 4 +- races/migrations/0001_initial.py | 6 +- races/models.py | 6 +- requirements-dev.txt | 108 +++++++++--------- requirements.txt | 65 ++++++----- storycraft/migrations/0001_initial.py | 6 +- .../migrations/0004_auto_20150619_2040.py | 6 +- storycraft/models.py | 6 +- ...4_add_mentions_output_channel_to_config.py | 2 +- twitter/models.py | 2 +- 24 files changed, 127 insertions(+), 117 deletions(-) diff --git a/dispatch/migrations/0002_auto_20150619_1124.py b/dispatch/migrations/0002_auto_20150619_1124.py index 8a92623..2598539 100644 --- a/dispatch/migrations/0002_auto_20150619_1124.py +++ b/dispatch/migrations/0002_auto_20150619_1124.py @@ -29,6 +29,6 @@ class Migration(migrations.Migration): migrations.AddField( model_name='dispatcheraction', name='dispatcher', - field=models.ForeignKey(to='dispatch.Dispatcher'), + field=models.ForeignKey(to='dispatch.Dispatcher', on_delete=models.CASCADE), ), ] diff --git a/dispatch/migrations/0003_auto_20150619_1637.py b/dispatch/migrations/0003_auto_20150619_1637.py index faaf4ed..1ccc40c 100644 --- a/dispatch/migrations/0003_auto_20150619_1637.py +++ b/dispatch/migrations/0003_auto_20150619_1637.py @@ -17,6 +17,6 @@ class Migration(migrations.Migration): migrations.AlterField( model_name='dispatcheraction', name='dispatcher', - field=models.ForeignKey(related_name='actions', to='dispatch.Dispatcher'), + field=models.ForeignKey(related_name='actions', to='dispatch.Dispatcher', on_delete=models.CASCADE), ), ] diff --git a/dispatch/models.py b/dispatch/models.py index fb3ab48..c879b91 100644 --- a/dispatch/models.py +++ b/dispatch/models.py @@ -36,7 +36,7 @@ class DispatcherAction(models.Model): (FILE_TYPE, "Write to file"), ) - dispatcher = models.ForeignKey('Dispatcher', related_name='actions') + dispatcher = models.ForeignKey('Dispatcher', related_name='actions', on_delete=models.CASCADE) type = models.CharField(max_length=16, choices=TYPE_CHOICES) destination = models.CharField(max_length=200) include_key = models.BooleanField(default=False) diff --git a/dr_botzo/settings.py b/dr_botzo/settings.py index 63c5f81..b4e2fa4 100644 --- a/dr_botzo/settings.py +++ b/dr_botzo/settings.py @@ -11,7 +11,7 @@ https://docs.djangoproject.com/en/1.6/ref/settings/ # Build paths inside the project like this: os.path.join(BASE_DIR, ...) import os -from django.core.urlresolvers import reverse_lazy +from django.urls import reverse_lazy BASE_DIR = os.path.dirname(os.path.dirname(__file__)) @@ -57,12 +57,11 @@ INSTALLED_APPS = ( 'twitter', ) -MIDDLEWARE_CLASSES = ( +MIDDLEWARE = ( 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', - 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', 'django.middleware.security.SecurityMiddleware', diff --git a/dr_botzo/urls.py b/dr_botzo/urls.py index b64da86..b163cf6 100644 --- a/dr_botzo/urls.py +++ b/dr_botzo/urls.py @@ -20,5 +20,5 @@ urlpatterns = [ url(r'^races/', include('races.urls')), url(r'^accounts/', include('registration.backends.default.urls')), - url(r'^admin/', include(admin.site.urls)), + url(r'^admin/', admin.site.urls), ] diff --git a/facts/migrations/0001_initial.py b/facts/migrations/0001_initial.py index 2a4d1d3..7df9dcd 100644 --- a/facts/migrations/0001_initial.py +++ b/facts/migrations/0001_initial.py @@ -26,6 +26,6 @@ class Migration(migrations.Migration): migrations.AddField( model_name='fact', name='category', - field=models.ForeignKey(to='facts.FactCategory'), + field=models.ForeignKey(to='facts.FactCategory', on_delete=models.CASCADE), ), ] diff --git a/facts/models.py b/facts/models.py index 63b1225..3966575 100644 --- a/facts/models.py +++ b/facts/models.py @@ -52,7 +52,7 @@ class Fact(models.Model): """Define facts.""" fact = models.TextField() - category = models.ForeignKey(FactCategory) + category = models.ForeignKey(FactCategory, on_delete=models.CASCADE) nickmask = models.CharField(max_length=200, default='', blank=True) time = models.DateTimeField(auto_now_add=True) diff --git a/gitlab_bot/migrations/0001_initial.py b/gitlab_bot/migrations/0001_initial.py index 4800d92..476b569 100644 --- a/gitlab_bot/migrations/0001_initial.py +++ b/gitlab_bot/migrations/0001_initial.py @@ -27,7 +27,7 @@ class Migration(migrations.Migration): ('code_reviews_necessary', models.PositiveSmallIntegerField(default=0)), ('code_reviewers', models.TextField(blank=True, default='')), ('code_review_final_merge_assignees', models.TextField(blank=True, default='')), - ('gitlab_config', models.ForeignKey(to='gitlab_bot.GitlabConfig', null=True)), + ('gitlab_config', models.ForeignKey(to='gitlab_bot.GitlabConfig', null=True, on_delete=models.CASCADE)), ], ), ] diff --git a/gitlab_bot/models.py b/gitlab_bot/models.py index b21c685..03933d2 100644 --- a/gitlab_bot/models.py +++ b/gitlab_bot/models.py @@ -23,7 +23,7 @@ class GitlabProjectConfig(models.Model): """Maintain settings for a particular project in GitLab.""" - gitlab_config = models.ForeignKey('GitlabConfig', null=True) + gitlab_config = models.ForeignKey('GitlabConfig', null=True, on_delete=models.CASCADE) project_id = models.CharField(max_length=64, unique=True) manage_merge_request_code_reviews = models.BooleanField(default=False) diff --git a/ircbot/migrations/0009_botadmin_user.py b/ircbot/migrations/0009_botadmin_user.py index 57be289..3bc9e02 100644 --- a/ircbot/migrations/0009_botadmin_user.py +++ b/ircbot/migrations/0009_botadmin_user.py @@ -15,7 +15,7 @@ class Migration(migrations.Migration): migrations.AddField( model_name='botadmin', name='user', - field=models.ForeignKey(default=1, to=settings.AUTH_USER_MODEL), + field=models.ForeignKey(default=1, to=settings.AUTH_USER_MODEL, on_delete=models.CASCADE), preserve_default=False, ), ] diff --git a/ircbot/models.py b/ircbot/models.py index e719a1e..a0d6050 100644 --- a/ircbot/models.py +++ b/ircbot/models.py @@ -47,7 +47,7 @@ class BotUser(models.Model): """Configure bot users, which can do things through the bot and standard Django auth.""" nickmask = models.CharField(max_length=200, unique=True) - user = models.ForeignKey(settings.AUTH_USER_MODEL) + user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE) class Meta: permissions = ( diff --git a/karma/migrations/0001_initial.py b/karma/migrations/0001_initial.py index 0ed0adc..f867d26 100644 --- a/karma/migrations/0001_initial.py +++ b/karma/migrations/0001_initial.py @@ -23,7 +23,7 @@ class Migration(migrations.Migration): ('delta', models.SmallIntegerField()), ('nickmask', models.CharField(default='', max_length=200, blank=True)), ('created', models.DateTimeField(auto_now_add=True)), - ('key', models.ForeignKey(to='karma.KarmaKey')), + ('key', models.ForeignKey(to='karma.KarmaKey', on_delete=models.CASCADE)), ], ), ] diff --git a/karma/models.py b/karma/models.py index 58a191d..f8f36ef 100644 --- a/karma/models.py +++ b/karma/models.py @@ -115,7 +115,7 @@ class KarmaLogEntryManager(models.Manager): class KarmaLogEntry(models.Model): """Track each karma increment/decrement.""" - key = models.ForeignKey('KarmaKey') + key = models.ForeignKey('KarmaKey', on_delete=models.CASCADE) delta = models.SmallIntegerField() nickmask = models.CharField(max_length=200, default='', blank=True) created = models.DateTimeField(auto_now_add=True) diff --git a/markov/migrations/0001_initial.py b/markov/migrations/0001_initial.py index eafc028..8d19676 100644 --- a/markov/migrations/0001_initial.py +++ b/markov/migrations/0001_initial.py @@ -27,7 +27,7 @@ class Migration(migrations.Migration): ('k2', models.CharField(max_length=128)), ('v', models.CharField(max_length=128)), ('count', models.IntegerField(default=0)), - ('context', models.ForeignKey(to='markov.MarkovContext')), + ('context', models.ForeignKey(to='markov.MarkovContext', on_delete=models.CASCADE)), ], options={ 'permissions': set([('teach_line', 'Can teach lines'), ('import_log_file', 'Can import states from a log file')]), @@ -40,7 +40,7 @@ class Migration(migrations.Migration): ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), ('name', models.CharField(unique=True, max_length=64)), ('chatter_chance', models.IntegerField(default=0)), - ('context', models.ForeignKey(to='markov.MarkovContext')), + ('context', models.ForeignKey(to='markov.MarkovContext', on_delete=models.CASCADE)), ], options={ }, diff --git a/markov/models.py b/markov/models.py index c78a19b..b23e150 100644 --- a/markov/models.py +++ b/markov/models.py @@ -28,7 +28,7 @@ class MarkovTarget(models.Model): """Define IRC targets that relate to a context, and can occasionally be talked to.""" name = models.CharField(max_length=200, unique=True) - context = models.ForeignKey(MarkovContext) + context = models.ForeignKey(MarkovContext, on_delete=models.CASCADE) chatter_chance = models.IntegerField(default=0) @@ -51,7 +51,7 @@ class MarkovState(models.Model): v = models.CharField(max_length=128) count = models.IntegerField(default=0) - context = models.ForeignKey(MarkovContext) + context = models.ForeignKey(MarkovContext, on_delete=models.CASCADE) class Meta: index_together = [ diff --git a/races/migrations/0001_initial.py b/races/migrations/0001_initial.py index 340eab4..f6f85a7 100644 --- a/races/migrations/0001_initial.py +++ b/races/migrations/0001_initial.py @@ -29,7 +29,7 @@ class Migration(migrations.Migration): ('joined', models.BooleanField(default=False)), ('started', models.BooleanField(default=False)), ('finished', models.BooleanField(default=False)), - ('race', models.ForeignKey(to='races.Race')), + ('race', models.ForeignKey(to='races.Race', on_delete=models.CASCADE)), ], options={ }, @@ -41,8 +41,8 @@ class Migration(migrations.Migration): ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), ('update', models.TextField()), ('event_time', models.DateTimeField(default=django.utils.timezone.now)), - ('race', models.ForeignKey(to='races.Race')), - ('racer', models.ForeignKey(to='races.Racer')), + ('race', models.ForeignKey(to='races.Race', on_delete=models.CASCADE)), + ('racer', models.ForeignKey(to='races.Racer', on_delete=models.CASCADE)), ], options={ 'ordering': ['event_time'], diff --git a/races/models.py b/races/models.py index c3d1062..09b5dcc 100644 --- a/races/models.py +++ b/races/models.py @@ -28,7 +28,7 @@ class Racer(models.Model): """Track a racer in a race.""" nick = models.CharField(max_length=64) - race = models.ForeignKey(Race) + race = models.ForeignKey(Race, on_delete=models.CASCADE) joined = models.BooleanField(default=False) started = models.BooleanField(default=False) @@ -47,8 +47,8 @@ class RaceUpdate(models.Model): """Periodic updates for a racer.""" - race = models.ForeignKey(Race) - racer = models.ForeignKey(Racer) + race = models.ForeignKey(Race, on_delete=models.CASCADE) + racer = models.ForeignKey(Racer, on_delete=models.CASCADE) update = models.TextField() event_time = models.DateTimeField(default=timezone.now) diff --git a/requirements-dev.txt b/requirements-dev.txt index ffed95c..1704e2e 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -2,64 +2,68 @@ # This file is autogenerated by pip-compile # To update, run: # -# pip-compile --output-file requirements-dev.txt requirements-dev.in +# pip-compile --output-file=requirements-dev.txt requirements-dev.in # -appdirs==1.4.0 # via setuptools -astroid==1.4.9 # via pylint, pylint-celery, pylint-flask, pylint-plugin-utils, requirements-detector -click==6.7 # via pip-tools +astroid==2.2.5 # via pylint, pylint-celery, pylint-flask, requirements-detector +certifi==2019.6.16 # via requests +chardet==3.0.4 # via requests +click==7.0 # via pip-tools django-adminplus==0.5 -django-bootstrap3==8.1.0 -django-extensions==1.7.6 -django-registration-redux==1.4 -django==1.10.5 -djangorestframework==3.5.3 +django-bootstrap3==11.0.0 +django-extensions==2.1.9 +django-registration-redux==2.6 +django==2.2.2 +djangorestframework==3.9.4 dodgy==0.1.9 # via prospector -first==2.0.1 # via pip-tools -future==0.16.0 # via parsedatetime -inflect==0.2.5 # via jaraco.itertools -irc==15.0.6 -isort==4.2.5 # via pylint -jaraco.classes==1.4 # via jaraco.collections -jaraco.collections==1.5 # via irc, jaraco.text -jaraco.functools==1.15.1 # via irc, jaraco.text -jaraco.itertools==2.0 # via irc -jaraco.logging==1.5 # via irc -jaraco.stream==1.1.1 # via irc -jaraco.text==1.9 # via irc, jaraco.collections -lazy-object-proxy==1.2.2 # via astroid -logilab-common==1.3.0 +future==0.17.1 # via parsedatetime +idna==2.8 # via requests +importlib-metadata==0.18 # via irc +inflect==2.1.0 # via jaraco.itertools +irc==17.1 +isort==4.3.20 # via pylint +jaraco.classes==2.0 # via jaraco.collections +jaraco.collections==2.0 # via irc +jaraco.functools==2.0 # via irc, jaraco.text, tempora +jaraco.itertools==4.4.2 # via irc +jaraco.logging==2.0 # via irc +jaraco.stream==2.0 # via irc +jaraco.text==3.0 # via irc, jaraco.collections +lazy-object-proxy==1.4.1 # via astroid +logilab-common==1.4.2 mccabe==0.6.1 # via prospector, pylint -more-itertools==2.5.0 # via irc, jaraco.functools, jaraco.itertools -oauthlib==2.0.1 # via requests-oauthlib -packaging==16.8 # via setuptools -parsedatetime==2.2 +more-itertools==7.0.0 # via irc, jaraco.functools, jaraco.itertools +oauthlib==3.0.1 # via requests-oauthlib +parsedatetime==2.4 pep8-naming==0.4.1 # via prospector -pip-tools==1.8.0 -ply==3.10 -prospector==0.12.4 -pycodestyle==2.0.0 # via prospector -pydocstyle==1.0.0 # via prospector -pyflakes==1.5.0 # via prospector +pip-tools==3.8.0 +ply==3.11 +prospector==1.1.6.4 +pycodestyle==2.4.0 # via prospector +pydocstyle==3.0.0 # via prospector +pyflakes==1.6.0 # via prospector pylint-celery==0.3 # via prospector -pylint-common==0.2.2 # via prospector -pylint-django==0.7.2 # via prospector -pylint-flask==0.5 # via prospector -pylint-plugin-utils==0.2.4 # via prospector, pylint-celery, pylint-django, pylint-flask -pylint==1.6.5 # via prospector, pylint-celery, pylint-common, pylint-django, pylint-flask, pylint-plugin-utils -pyparsing==2.1.10 # via packaging -python-dateutil==2.6.0 -python-gitlab==0.18 -python-mpd2==0.5.5 -pytz==2016.10 -pyyaml==3.12 # via prospector -requests-oauthlib==0.7.0 # via twython -requests==2.13.0 # via python-gitlab, requests-oauthlib, twython -requirements-detector==0.5.2 # via prospector +pylint-django==2.0.9 # via prospector +pylint-flask==0.6 # via prospector +pylint-plugin-utils==0.5 # via prospector, pylint-celery, pylint-django, pylint-flask +pylint==2.3.1 # via prospector, pylint-celery, pylint-django, pylint-flask, pylint-plugin-utils +python-dateutil==2.8.0 +python-gitlab==1.9.0 +python-mpd2==1.0.0 +pytz==2019.1 +pyyaml==5.1.1 # via prospector +requests-oauthlib==1.2.0 # via twython +requests==2.22.0 # via python-gitlab, requests-oauthlib, twython +requirements-detector==0.6 # via prospector setoptconf==0.2.0 # via prospector -six==1.10.0 # via astroid, django-extensions, irc, jaraco.classes, jaraco.collections, jaraco.itertools, jaraco.logging, jaraco.stream, logilab-common, more-itertools, packaging, pip-tools, pylint, python-dateutil, python-gitlab, setuptools, tempora -tempora==1.6.1 # via irc, jaraco.logging -twython==3.4.0 -wrapt==1.10.8 # via astroid +six==1.12.0 # via astroid, django-extensions, jaraco.classes, jaraco.collections, jaraco.itertools, jaraco.logging, jaraco.stream, logilab-common, pip-tools, pydocstyle, python-dateutil, python-gitlab, tempora +snowballstemmer==1.2.1 # via pydocstyle +sqlparse==0.3.0 # via django +tempora==1.14.1 # via irc, jaraco.logging +twython==3.7.0 +typed-ast==1.4.0 # via astroid +urllib3==1.25.3 # via requests +wrapt==1.11.2 # via astroid +zipp==0.5.1 # via importlib-metadata # The following packages are considered to be unsafe in a requirements file: -# setuptools # via logilab-common +# setuptools==41.0.1 # via logilab-common diff --git a/requirements.txt b/requirements.txt index b3c45e6..0a9d80a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,34 +2,41 @@ # This file is autogenerated by pip-compile # To update, run: # -# pip-compile --output-file requirements.txt requirements.in +# pip-compile --output-file=requirements.txt requirements.in # +certifi==2019.6.16 # via requests +chardet==3.0.4 # via requests django-adminplus==0.5 -django-bootstrap3==8.1.0 -django-extensions==1.7.6 -django-registration-redux==1.4 -django==1.10.5 -djangorestframework==3.5.3 -future==0.16.0 # via parsedatetime -inflect==0.2.5 # via jaraco.itertools -irc==15.0.6 -jaraco.classes==1.4 # via jaraco.collections -jaraco.collections==1.5 # via irc, jaraco.text -jaraco.functools==1.15.1 # via irc, jaraco.text -jaraco.itertools==2.0 # via irc -jaraco.logging==1.5 # via irc -jaraco.stream==1.1.1 # via irc -jaraco.text==1.9 # via irc, jaraco.collections -more-itertools==2.5.0 # via irc, jaraco.functools, jaraco.itertools -oauthlib==2.0.1 # via requests-oauthlib -parsedatetime==2.2 -ply==3.10 -python-dateutil==2.6.0 -python-gitlab==0.18 -python-mpd2==0.5.5 -pytz==2016.10 -requests-oauthlib==0.7.0 # via twython -requests==2.13.0 # via python-gitlab, requests-oauthlib, twython -six==1.10.0 # via django-extensions, irc, jaraco.classes, jaraco.collections, jaraco.itertools, jaraco.logging, jaraco.stream, more-itertools, python-dateutil, python-gitlab, tempora -tempora==1.6.1 # via irc, jaraco.logging -twython==3.4.0 +django-bootstrap3==11.0.0 +django-extensions==2.1.9 +django-registration-redux==2.6 +django==2.2.2 +djangorestframework==3.9.4 +future==0.17.1 # via parsedatetime +idna==2.8 # via requests +importlib-metadata==0.18 # via irc +inflect==2.1.0 # via jaraco.itertools +irc==17.1 +jaraco.classes==2.0 # via jaraco.collections +jaraco.collections==2.0 # via irc +jaraco.functools==2.0 # via irc, jaraco.text, tempora +jaraco.itertools==4.4.2 # via irc +jaraco.logging==2.0 # via irc +jaraco.stream==2.0 # via irc +jaraco.text==3.0 # via irc, jaraco.collections +more-itertools==7.0.0 # via irc, jaraco.functools, jaraco.itertools +oauthlib==3.0.1 # via requests-oauthlib +parsedatetime==2.4 +ply==3.11 +python-dateutil==2.8.0 +python-gitlab==1.9.0 +python-mpd2==1.0.0 +pytz==2019.1 +requests-oauthlib==1.2.0 # via twython +requests==2.22.0 # via python-gitlab, requests-oauthlib, twython +six==1.12.0 # via django-extensions, jaraco.classes, jaraco.collections, jaraco.itertools, jaraco.logging, jaraco.stream, python-dateutil, python-gitlab, tempora +sqlparse==0.3.0 # via django +tempora==1.14.1 # via irc, jaraco.logging +twython==3.7.0 +urllib3==1.25.3 # via requests +zipp==0.5.1 # via importlib-metadata diff --git a/storycraft/migrations/0001_initial.py b/storycraft/migrations/0001_initial.py index cf21ec1..3d5a106 100644 --- a/storycraft/migrations/0001_initial.py +++ b/storycraft/migrations/0001_initial.py @@ -29,7 +29,7 @@ class Migration(migrations.Migration): ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), ('line', models.TextField(default='')), ('time', models.DateTimeField(auto_now_add=True)), - ('game', models.ForeignKey(to='storycraft.StorycraftGame')), + ('game', models.ForeignKey(to='storycraft.StorycraftGame', on_delete=models.CASCADE)), ], ), migrations.CreateModel( @@ -38,12 +38,12 @@ class Migration(migrations.Migration): ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), ('nick', models.CharField(max_length=64)), ('nickmask', models.CharField(max_length=200)), - ('game', models.ForeignKey(to='storycraft.StorycraftGame')), + ('game', models.ForeignKey(to='storycraft.StorycraftGame', on_delete=models.CASCADE)), ], ), migrations.AddField( model_name='storycraftline', name='player', - field=models.ForeignKey(to='storycraft.StorycraftPlayer'), + field=models.ForeignKey(to='storycraft.StorycraftPlayer', on_delete=models.CASCADE), ), ] diff --git a/storycraft/migrations/0004_auto_20150619_2040.py b/storycraft/migrations/0004_auto_20150619_2040.py index 3f78217..97b0389 100644 --- a/storycraft/migrations/0004_auto_20150619_2040.py +++ b/storycraft/migrations/0004_auto_20150619_2040.py @@ -13,16 +13,16 @@ class Migration(migrations.Migration): migrations.AlterField( model_name='storycraftline', name='game', - field=models.ForeignKey(related_name='lines', to='storycraft.StorycraftGame'), + field=models.ForeignKey(related_name='lines', to='storycraft.StorycraftGame', on_delete=models.CASCADE), ), migrations.AlterField( model_name='storycraftline', name='player', - field=models.ForeignKey(related_name='lines', to='storycraft.StorycraftPlayer'), + field=models.ForeignKey(related_name='lines', to='storycraft.StorycraftPlayer', on_delete=models.CASCADE), ), migrations.AlterField( model_name='storycraftplayer', name='game', - field=models.ForeignKey(related_name='players', to='storycraft.StorycraftGame'), + field=models.ForeignKey(related_name='players', to='storycraft.StorycraftGame', on_delete=models.CASCADE), ), ] diff --git a/storycraft/models.py b/storycraft/models.py index 680697b..dcf839b 100644 --- a/storycraft/models.py +++ b/storycraft/models.py @@ -89,7 +89,7 @@ class StorycraftPlayer(models.Model): """Contain entire games of storycraft.""" - game = models.ForeignKey('StorycraftGame', related_name='players') + game = models.ForeignKey('StorycraftGame', related_name='players', on_delete=models.CASCADE) nick = models.CharField(max_length=64) nickmask = models.CharField(max_length=200) @@ -103,8 +103,8 @@ class StorycraftLine(models.Model): """Handle requests to dispatchers and do something with them.""" - game = models.ForeignKey('StorycraftGame', related_name='lines') - player = models.ForeignKey('StorycraftPlayer', related_name='lines') + game = models.ForeignKey('StorycraftGame', related_name='lines', on_delete=models.CASCADE) + player = models.ForeignKey('StorycraftPlayer', related_name='lines', on_delete=models.CASCADE) line = models.TextField(default="") time = models.DateTimeField(auto_now_add=True) diff --git a/twitter/migrations/0004_add_mentions_output_channel_to_config.py b/twitter/migrations/0004_add_mentions_output_channel_to_config.py index f04a04d..8c78abe 100644 --- a/twitter/migrations/0004_add_mentions_output_channel_to_config.py +++ b/twitter/migrations/0004_add_mentions_output_channel_to_config.py @@ -19,6 +19,6 @@ class Migration(migrations.Migration): migrations.AddField( model_name='twitterclient', name='mentions_output_channel', - field=models.ForeignKey(blank=True, related_name='mentions_twitter_client', null=True, to='ircbot.IrcChannel', default=None), + field=models.ForeignKey(blank=True, related_name='mentions_twitter_client', null=True, to='ircbot.IrcChannel', default=None, on_delete=models.CASCADE), ), ] diff --git a/twitter/models.py b/twitter/models.py index 0020c4b..0cc3f15 100644 --- a/twitter/models.py +++ b/twitter/models.py @@ -18,7 +18,7 @@ class TwitterClient(models.Model): oauth_token_secret = models.CharField(max_length=256, default='', blank=True) mentions_output_channel = models.ForeignKey(IrcChannel, related_name='mentions_twitter_client', default=None, - null=True, blank=True) + null=True, blank=True, on_delete=models.CASCADE) mentions_since_id = models.PositiveIntegerField(default=1, blank=True) class Meta: From 0f88715ffd9d943663d12a6e499b9269bc3e571c Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Fri, 21 Jun 2019 10:06:17 -0500 Subject: [PATCH 02/21] remove unnecessary requirements-server.* --- requirements-server.in | 3 --- requirements-server.txt | 36 ------------------------------------ 2 files changed, 39 deletions(-) delete mode 100644 requirements-server.in delete mode 100644 requirements-server.txt diff --git a/requirements-server.in b/requirements-server.in deleted file mode 100644 index c08c3d9..0000000 --- a/requirements-server.in +++ /dev/null @@ -1,3 +0,0 @@ --r requirements.in - -psycopg2 diff --git a/requirements-server.txt b/requirements-server.txt deleted file mode 100644 index 42a1eb4..0000000 --- a/requirements-server.txt +++ /dev/null @@ -1,36 +0,0 @@ -# -# This file is autogenerated by pip-compile -# To update, run: -# -# pip-compile --output-file requirements-server.txt requirements-server.in -# -django-adminplus==0.5 -django-bootstrap3==8.1.0 -django-extensions==1.7.6 -django-registration-redux==1.4 -django==1.10.5 -djangorestframework==3.5.3 -future==0.16.0 # via parsedatetime -inflect==0.2.5 # via jaraco.itertools -irc==15.0.6 -jaraco.classes==1.4 # via jaraco.collections -jaraco.collections==1.5 # via irc, jaraco.text -jaraco.functools==1.15.1 # via irc, jaraco.text -jaraco.itertools==2.0 # via irc -jaraco.logging==1.5 # via irc -jaraco.stream==1.1.1 # via irc -jaraco.text==1.9 # via irc, jaraco.collections -more-itertools==2.5.0 # via irc, jaraco.functools, jaraco.itertools -oauthlib==2.0.1 # via requests-oauthlib -parsedatetime==2.2 -ply==3.10 -psycopg2==2.6.2 -python-dateutil==2.6.0 -python-gitlab==0.18 -python-mpd2==0.5.5 -pytz==2016.10 -requests-oauthlib==0.7.0 # via twython -requests==2.13.0 # via python-gitlab, requests-oauthlib, twython -six==1.10.0 # via django-extensions, irc, jaraco.classes, jaraco.collections, jaraco.itertools, jaraco.logging, jaraco.stream, more-itertools, python-dateutil, python-gitlab, tempora -tempora==1.6.1 # via irc, jaraco.logging -twython==3.4.0 From f2fb0a26a42f62fd82b61354eddd251fcafbb286 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Fri, 21 Jun 2019 15:23:33 -0500 Subject: [PATCH 03/21] remove unnecessary unicode_literal future imports, we py3 now --- countdown/migrations/0003_auto_20170222_2025.py | 2 -- countdown/migrations/0004_countdownitem_recurring_period.py | 2 -- countdown/migrations/0005_countdownitem_recurring_until.py | 2 -- dice/ircplugin.py | 4 ---- dispatch/migrations/0005_auto_20160116_1955.py | 2 -- facts/migrations/0006_factcategory_show_all_entries.py | 2 -- gitlab_bot/migrations/0001_initial.py | 2 -- gitlab_bot/migrations/0002_auto_20160624_1354.py | 2 -- ircbot/migrations/0014_auto_20160116_1955.py | 2 -- markov/migrations/0003_auto_20161112_2348.py | 2 -- scripts/mpd-notifications/mpd-notifications.py | 3 --- .../migrations/0004_add_mentions_output_channel_to_config.py | 2 -- .../0005_replace_since_id_with_replies_specific_one.py | 2 -- twitter/migrations/0006_add_manage_threads_permission.py | 2 -- 14 files changed, 31 deletions(-) diff --git a/countdown/migrations/0003_auto_20170222_2025.py b/countdown/migrations/0003_auto_20170222_2025.py index af04f97..99b803d 100644 --- a/countdown/migrations/0003_auto_20170222_2025.py +++ b/countdown/migrations/0003_auto_20170222_2025.py @@ -1,7 +1,5 @@ # -*- coding: utf-8 -*- # Generated by Django 1.10.5 on 2017-02-23 02:25 -from __future__ import unicode_literals - from django.db import migrations, models diff --git a/countdown/migrations/0004_countdownitem_recurring_period.py b/countdown/migrations/0004_countdownitem_recurring_period.py index 608859f..bd4ee2c 100644 --- a/countdown/migrations/0004_countdownitem_recurring_period.py +++ b/countdown/migrations/0004_countdownitem_recurring_period.py @@ -1,7 +1,5 @@ # -*- coding: utf-8 -*- # Generated by Django 1.10.5 on 2017-02-24 01:06 -from __future__ import unicode_literals - from django.db import migrations, models diff --git a/countdown/migrations/0005_countdownitem_recurring_until.py b/countdown/migrations/0005_countdownitem_recurring_until.py index 9825ea6..1dc5184 100644 --- a/countdown/migrations/0005_countdownitem_recurring_until.py +++ b/countdown/migrations/0005_countdownitem_recurring_until.py @@ -1,7 +1,5 @@ # -*- coding: utf-8 -*- # Generated by Django 1.10.5 on 2017-02-24 01:12 -from __future__ import unicode_literals - from django.db import migrations, models diff --git a/dice/ircplugin.py b/dice/ircplugin.py index 51b57bf..b8fcac9 100644 --- a/dice/ircplugin.py +++ b/dice/ircplugin.py @@ -1,8 +1,4 @@ """Roll dice when asked, intended for RPGs.""" - -# this breaks yacc, but ply might be happy in py3 -#from __future__ import unicode_literals - import logging import math import re diff --git a/dispatch/migrations/0005_auto_20160116_1955.py b/dispatch/migrations/0005_auto_20160116_1955.py index 784d79a..d4a2659 100644 --- a/dispatch/migrations/0005_auto_20160116_1955.py +++ b/dispatch/migrations/0005_auto_20160116_1955.py @@ -1,6 +1,4 @@ # -*- coding: utf-8 -*- -from __future__ import unicode_literals - from django.db import migrations, models diff --git a/facts/migrations/0006_factcategory_show_all_entries.py b/facts/migrations/0006_factcategory_show_all_entries.py index b324817..0b07c30 100644 --- a/facts/migrations/0006_factcategory_show_all_entries.py +++ b/facts/migrations/0006_factcategory_show_all_entries.py @@ -1,7 +1,5 @@ # -*- coding: utf-8 -*- # Generated by Django 1.10.5 on 2017-02-11 15:00 -from __future__ import unicode_literals - from django.db import migrations, models diff --git a/gitlab_bot/migrations/0001_initial.py b/gitlab_bot/migrations/0001_initial.py index 476b569..944fea1 100644 --- a/gitlab_bot/migrations/0001_initial.py +++ b/gitlab_bot/migrations/0001_initial.py @@ -1,6 +1,4 @@ # -*- coding: utf-8 -*- -from __future__ import unicode_literals - from django.db import migrations, models diff --git a/gitlab_bot/migrations/0002_auto_20160624_1354.py b/gitlab_bot/migrations/0002_auto_20160624_1354.py index 8e026bb..33e5fe6 100644 --- a/gitlab_bot/migrations/0002_auto_20160624_1354.py +++ b/gitlab_bot/migrations/0002_auto_20160624_1354.py @@ -1,6 +1,4 @@ # -*- coding: utf-8 -*- -from __future__ import unicode_literals - from django.db import migrations, models diff --git a/ircbot/migrations/0014_auto_20160116_1955.py b/ircbot/migrations/0014_auto_20160116_1955.py index 2a35df9..ef1d36d 100644 --- a/ircbot/migrations/0014_auto_20160116_1955.py +++ b/ircbot/migrations/0014_auto_20160116_1955.py @@ -1,6 +1,4 @@ # -*- coding: utf-8 -*- -from __future__ import unicode_literals - from django.db import migrations, models diff --git a/markov/migrations/0003_auto_20161112_2348.py b/markov/migrations/0003_auto_20161112_2348.py index bededdd..e08dcd4 100644 --- a/markov/migrations/0003_auto_20161112_2348.py +++ b/markov/migrations/0003_auto_20161112_2348.py @@ -1,6 +1,4 @@ # -*- coding: utf-8 -*- -from __future__ import unicode_literals - from django.db import migrations, models diff --git a/scripts/mpd-notifications/mpd-notifications.py b/scripts/mpd-notifications/mpd-notifications.py index 07d1092..cc6b1e1 100644 --- a/scripts/mpd-notifications/mpd-notifications.py +++ b/scripts/mpd-notifications/mpd-notifications.py @@ -1,7 +1,4 @@ """Use dr.botzo's Dispatch to send mpd notifications.""" - -from __future__ import unicode_literals - import argparse import getpass import logging diff --git a/twitter/migrations/0004_add_mentions_output_channel_to_config.py b/twitter/migrations/0004_add_mentions_output_channel_to_config.py index 8c78abe..8cc3512 100644 --- a/twitter/migrations/0004_add_mentions_output_channel_to_config.py +++ b/twitter/migrations/0004_add_mentions_output_channel_to_config.py @@ -1,6 +1,4 @@ # -*- coding: utf-8 -*- -from __future__ import unicode_literals - from django.db import migrations, models diff --git a/twitter/migrations/0005_replace_since_id_with_replies_specific_one.py b/twitter/migrations/0005_replace_since_id_with_replies_specific_one.py index 37b7d88..116172f 100644 --- a/twitter/migrations/0005_replace_since_id_with_replies_specific_one.py +++ b/twitter/migrations/0005_replace_since_id_with_replies_specific_one.py @@ -1,6 +1,4 @@ # -*- coding: utf-8 -*- -from __future__ import unicode_literals - from django.db import migrations, models diff --git a/twitter/migrations/0006_add_manage_threads_permission.py b/twitter/migrations/0006_add_manage_threads_permission.py index d154df5..91d7856 100644 --- a/twitter/migrations/0006_add_manage_threads_permission.py +++ b/twitter/migrations/0006_add_manage_threads_permission.py @@ -1,6 +1,4 @@ # -*- coding: utf-8 -*- -from __future__ import unicode_literals - from django.db import migrations, models From 852815248373dce973dbad1cdb5c5c4659bdf676 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Fri, 21 Jun 2019 16:49:02 -0500 Subject: [PATCH 04/21] remove dice cthulhutech roll. hasn't been used in forever --- dice/ircplugin.py | 117 ++-------------------------------------------- 1 file changed, 5 insertions(+), 112 deletions(-) diff --git a/dice/ircplugin.py b/dice/ircplugin.py index b8fcac9..c9f2668 100644 --- a/dice/ircplugin.py +++ b/dice/ircplugin.py @@ -1,6 +1,5 @@ """Roll dice when asked, intended for RPGs.""" import logging -import math import re import random @@ -15,18 +14,17 @@ logger = logging.getLogger(__name__) class Dice(Plugin): - """Roll simple or complex dice strings.""" + def __init__(self): + """Set up the plugin.""" + super(Dice, self).__init__() + self.roller = DiceRoller() + def start(self): """Set up the handlers.""" - - self.roller = DiceRoller() - self.connection.reactor.add_global_regex_handler(['pubmsg', 'privmsg'], r'^!roll\s+(.*)$', self.handle_roll, -20) - self.connection.reactor.add_global_regex_handler(['pubmsg', 'privmsg'], r'^!ctech\s+(.*)$', - self.handle_ctech, -20) self.connection.reactor.add_global_regex_handler(['pubmsg', 'privmsg'], r'^!random\s+(.*)$', self.handle_random, -20) @@ -34,9 +32,7 @@ class Dice(Plugin): def stop(self): """Tear down handlers.""" - self.connection.reactor.remove_global_regex_handler(['pubmsg', 'privmsg'], self.handle_roll) - self.connection.reactor.remove_global_regex_handler(['pubmsg', 'privmsg'], self.handle_ctech) self.connection.reactor.remove_global_regex_handler(['pubmsg', 'privmsg'], self.handle_random) super(Dice, self).stop() @@ -70,109 +66,6 @@ class Dice(Plugin): reply = "{0:s}: {1:s}".format(nick, self.roller.do_roll(dicestr)) return self.bot.reply(event, re.sub(r'(\d+)(.*?\s+)(\(.*?\))', r'\1\214\3', reply)) - def handle_ctech(self, connection, event, match): - """Handle cthulhutech dice rolls.""" - - nick = NickMask(event.source).nick - rollitrs = re.split(';\s*', match.group(1)) - reply = "" - for count, roll in enumerate(rollitrs): - pattern = '^(\d+)d(?:(\+|\-)(\d+))?(?:\s+(.*))?' - regex = re.compile(pattern) - matches = regex.search(roll) - if matches is not None: - dice = int(matches.group(1)) - modifier = 0 - - if matches.group(2) is not None and matches.group(3) is not None: - if str(matches.group(2)) == '-': - modifier = -1 * int(matches.group(3)) - else: - modifier = int(matches.group(3)) - - result = roll + ': ' - - rolls = [] - for d in range(dice): - rolls.append(random.randint(1, 10)) - rolls.sort() - rolls.reverse() - - # highest single die method - method1 = rolls[0] - - # highest set method - method2 = 0 - rolling_sum = 0 - for i, r in enumerate(rolls): - # if next roll is same as current, sum and continue, else see if sum is best so far - if i+1 < len(rolls) and rolls[i+1] == r: - if rolling_sum == 0: - rolling_sum = r - rolling_sum += r - else: - if rolling_sum > method2: - method2 = rolling_sum - rolling_sum = 0 - # check for set in progress (e.g. lots of 1s) - if rolling_sum > method2: - method2 = rolling_sum - - # straight method - method3 = 0 - rolling_sum = 0 - count = 0 - for i, r in enumerate(rolls): - # if next roll is one less as current, sum and continue, else check len and see if sum is best so far - if i+1 < len(rolls) and rolls[i+1] == r-1: - if rolling_sum == 0: - rolling_sum = r - count += 1 - rolling_sum += r-1 - count += 1 - else: - if count >= 3 and rolling_sum > method3: - method3 = rolling_sum - rolling_sum = 0 - # check for straight in progress (e.g. straight ending in 1) - if count >= 3 and rolling_sum > method3: - method3 = rolling_sum - - # get best roll - best = max([method1, method2, method3]) - - # check for critical failure - botch = False - ones = 0 - for r in rolls: - if r == 1: - ones += 1 - if ones >= math.ceil(float(len(rolls))/2): - botch = True - - if botch: - result += 'BOTCH' - else: - result += str(best + modifier) - rollres = '' - for i,r in enumerate(rolls): - rollres += str(r) - if i is not len(rolls)-1: - rollres += ',' - result += ' [' + rollres - if modifier != 0: - if modifier > 0: - result += ' +' + str(modifier) - else: - result += ' -' + str(modifier * -1) - result += ']' - - reply += result - if count is not len(rollitrs)-1: - reply += "; " - if reply is not "": - msg = "{0:s}: {1:s}".format(nick, reply) - return self.bot.reply(event, msg) class DiceRoller(object): From f78d407d4cbfa6c5a17ba611c0ddb367b54e72ce Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Fri, 21 Jun 2019 16:51:43 -0500 Subject: [PATCH 05/21] move DiceRoller to its own module while I'm doing that, standardize the usage of raising exceptions when parsing goes wrong --- dice/ircplugin.py | 270 ++-------------------------------------------- dice/roller.py | 263 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 273 insertions(+), 260 deletions(-) create mode 100644 dice/roller.py diff --git a/dice/ircplugin.py b/dice/ircplugin.py index c9f2668..99c7904 100644 --- a/dice/ircplugin.py +++ b/dice/ircplugin.py @@ -5,9 +5,7 @@ import random from irc.client import NickMask -import ply.lex as lex -import ply.yacc as yacc - +from dice.roller import DiceRoller from ircbot.lib import Plugin logger = logging.getLogger(__name__) @@ -60,265 +58,17 @@ class Dice(Plugin): dicestr = match.group(1) logger.debug(event.recursing) + try: + reply_str = self.roller.do_roll(dicestr) + except AssertionError as aex: + reply_str = f"Could not roll dice: {aex}" + except ValueError: + reply_str = "Unable to parse roll" + if event.recursing: - reply = "{0:s}".format(self.roller.do_roll(dicestr)) + reply = "{0:s}".format(reply_str) else: - reply = "{0:s}: {1:s}".format(nick, self.roller.do_roll(dicestr)) + reply = "{0:s}: {1:s}".format(nick, reply_str) return self.bot.reply(event, re.sub(r'(\d+)(.*?\s+)(\(.*?\))', r'\1\214\3', reply)) - - -class DiceRoller(object): - - tokens = ['NUMBER', 'TEXT', 'ROLLSEP'] - literals = ['#', '/', '+', '-', 'd'] - - t_TEXT = r'\s+[^;]+' - t_ROLLSEP = r';\s*' - - def build(self): - lex.lex(module=self) - yacc.yacc(module=self) - - def t_NUMBER(self, t): - r'\d+' - t.value = int(t.value) - return t - - def t_error(self, t): - t.lexer.skip(1) - - precedence = ( - ('left', 'ROLLSEP'), - ('left', '+', '-'), - ('right', 'd'), - ('left', '#'), - ('left', '/') - ) - - output = "" - - def roll_dice(self, keep, dice, size): - """Takes the parsed dice string for a single roll (eg 3/4d20) and performs - the actual roll. Returns a string representing the result. - """ - - a = list(range(dice)) - for i in range(dice): - a[i] = random.randint(1, size) - if keep != dice: - b = sorted(a, reverse=True) - b = b[0:keep] - else: - b = a - total = sum(b) - outstr = "[" + ",".join(str(i) for i in a) + "]" - - return (total, outstr) - - def process_roll(self, trials, mods, comment): - """Processes rolls coming from the parser. - - This generates the inputs for the roll_dice() command, and returns - the full string representing the whole current dice string (the part - up to a semicolon or end of line). - """ - - output = "" - repeat = 1 - if trials != None: - repeat = trials - for i in range(repeat): - mode = 1 - total = 0 - curr_str = "" - if i > 0: - output += ", " - for m in mods: - keep = 0 - dice = 1 - res = 0 - # if m is a tuple, then it is a die roll - # m[0] = (keep, num dice) - # m[1] = num faces on the die - if type(m) == tuple: - if m[0] != None: - if m[0][0] != None: - keep = m[0][0] - dice = m[0][1] - size = m[1] - if keep > dice or keep == 0: - keep = dice - if size < 1: - output = "# of sides for die is incorrect: %d" % size - return output - if dice < 1: - output = "# of dice is incorrect: %d" % dice - return output - res = self.roll_dice(keep, dice, size) - curr_str += "%d%s" % (res[0], res[1]) - res = res[0] - elif m == "+": - mode = 1 - curr_str += "+" - elif m == "-": - mode = -1 - curr_str += "-" - else: - res = m - curr_str += str(m) - total += mode * res - if repeat == 1: - if comment != None: - output = "%d %s (%s)" % (total, comment.strip(), curr_str) - else: - output = "%d (%s)" % (total, curr_str) - else: - output += "%d (%s)" % (total, curr_str) - if i == repeat - 1: - if comment != None: - output += " (%s)" % (comment.strip()) - return output - - def p_roll_r(self, p): - # Chain rolls together. - - # General idea I had when creating this grammar: A roll string is a chain - # of modifiers, which may be repeated for a certain number of trials. It can - # have a comment that describes the roll - # Multiple roll strings can be chained with semicolon - - 'roll : roll ROLLSEP roll' - global output - p[0] = p[1] + "; " + p[3] - output = p[0] - - def p_roll(self, p): - # Parse a basic roll string. - - 'roll : trial modifier comment' - global output - mods = [] - if type(p[2]) == list: - mods = p[2] - else: - mods = [p[2]] - p[0] = self.process_roll(p[1], mods, p[3]) - output = p[0] - - def p_roll_no_trials(self, p): - # Parse a roll string without trials. - - 'roll : modifier comment' - global output - mods = [] - if type(p[1]) == list: - mods = p[1] - else: - mods = [p[1]] - p[0] = self.process_roll(None, mods, p[2]) - output = p[0] - - def p_comment(self, p): - # Parse a comment. - - '''comment : TEXT - |''' - if len(p) == 2: - p[0] = p[1] - else: - p[0] = None - - def p_modifier(self, p): - # Parse a modifier on a roll string. - - '''modifier : modifier "+" modifier - | modifier "-" modifier''' - # Use append to prevent nested lists (makes dealing with this easier) - if type(p[1]) == list: - p[1].append(p[2]) - p[1].append(p[3]) - p[0] = p[1] - elif type(p[3]) == list: - p[3].insert(0, p[2]) - p[3].insert(0, p[1]) - p[0] = p[3] - else: - p[0] = [p[1], p[2], p[3]] - - def p_die(self, p): - # Return the left side before the "d", and the number of faces. - - 'modifier : left NUMBER' - p[0] = (p[1], p[2]) - - def p_die_num(self, p): - 'modifier : NUMBER' - p[0] = p[1] - - def p_left(self, p): - # Parse the number of dice we are rolling, and how many we are keeping. - 'left : keep dice' - if p[1] == None: - p[0] = [None, p[2]] - else: - p[0] = [p[1], p[2]] - - def p_left_all(self, p): - 'left : dice' - p[0] = [None, p[1]] - - def p_left_e(self, p): - 'left :' - p[0] = None - - def p_total(self, p): - 'trial : NUMBER "#"' - if len(p) > 1: - p[0] = p[1] - else: - p[0] = None - - def p_keep(self, p): - 'keep : NUMBER "/"' - if p[1] != None: - p[0] = p[1] - else: - p[0] = None - - def p_dice(self, p): - 'dice : NUMBER "d"' - p[0] = p[1] - - def p_dice_one(self, p): - 'dice : "d"' - p[0] = 1 - - def p_error(self, p): - # Provide the user with something (albeit not much) when the roll can't be parsed. - global output - output = "Unable to parse roll" - - def get_result(self): - global output - return output - - def do_roll(self, dicestr): - """ - Roll some dice and get the result (with broken out rolls). - - Keyword arguments: - dicestr - format: - N#X/YdS+M label - N#: do the following roll N times (optional) - X/: take the top X rolls of the Y times rolled (optional) - Y : roll the die specified Y times (optional, defaults to 1) - dS: roll a S-sided die - +M: add M to the result (-M for subtraction) (optional) - """ - self.build() - yacc.parse(dicestr) - return self.get_result() - - plugin = Dice diff --git a/dice/roller.py b/dice/roller.py new file mode 100644 index 0000000..3a06f1e --- /dev/null +++ b/dice/roller.py @@ -0,0 +1,263 @@ +"""Dice rollers used by the views, bots, etc.""" +import logging +import random + +import ply.lex as lex +import ply.yacc as yacc + +logger = logging.getLogger(__name__) + + +class DiceRoller(object): + + tokens = ['NUMBER', 'TEXT', 'ROLLSEP'] + literals = ['#', '/', '+', '-', 'd'] + + t_TEXT = r'\s+[^;]+' + t_ROLLSEP = r';\s*' + + def build(self): + lex.lex(module=self) + yacc.yacc(module=self) + + def t_NUMBER(self, t): + r'\d+' + t.value = int(t.value) + return t + + def t_error(self, t): + t.lexer.skip(1) + + precedence = ( + ('left', 'ROLLSEP'), + ('left', '+', '-'), + ('right', 'd'), + ('left', '#'), + ('left', '/') + ) + + output = "" + + def roll_dice(self, keep, dice, size): + """Takes the parsed dice string for a single roll (eg 3/4d20) and performs + the actual roll. Returns a string representing the result. + """ + + a = list(range(dice)) + for i in range(dice): + a[i] = random.randint(1, size) + if keep != dice: + b = sorted(a, reverse=True) + b = b[0:keep] + else: + b = a + total = sum(b) + outstr = "[" + ",".join(str(i) for i in a) + "]" + + return (total, outstr) + + def process_roll(self, trials, mods, comment): + """Processes rolls coming from the parser. + + This generates the inputs for the roll_dice() command, and returns + the full string representing the whole current dice string (the part + up to a semicolon or end of line). + """ + rolls = mods[0][0][1] if mods[0][0][1] else 1 + assert trials <= 10, "Too many rolls (max: 10)." + assert rolls <= 50, "Too many dice (max: 50) in roll." + + output = "" + repeat = 1 + if trials != None: + repeat = trials + for i in range(repeat): + mode = 1 + total = 0 + curr_str = "" + if i > 0: + output += ", " + for m in mods: + keep = 0 + dice = 1 + res = 0 + # if m is a tuple, then it is a die roll + # m[0] = (keep, num dice) + # m[1] = num faces on the die + if type(m) == tuple: + if m[0] != None: + if m[0][0] != None: + keep = m[0][0] + dice = m[0][1] + size = m[1] + if keep > dice or keep == 0: + keep = dice + if size < 1: + output = "# of sides for die is incorrect: %d" % size + return output + if dice < 1: + output = "# of dice is incorrect: %d" % dice + return output + res = self.roll_dice(keep, dice, size) + curr_str += "%d%s" % (res[0], res[1]) + res = res[0] + elif m == "+": + mode = 1 + curr_str += "+" + elif m == "-": + mode = -1 + curr_str += "-" + else: + res = m + curr_str += str(m) + total += mode * res + if repeat == 1: + if comment != None: + output = "%d %s (%s)" % (total, comment.strip(), curr_str) + else: + output = "%d (%s)" % (total, curr_str) + else: + output += "%d (%s)" % (total, curr_str) + if i == repeat - 1: + if comment != None: + output += " (%s)" % (comment.strip()) + return output + + def p_roll_r(self, p): + # Chain rolls together. + + # General idea I had when creating this grammar: A roll string is a chain + # of modifiers, which may be repeated for a certain number of trials. It can + # have a comment that describes the roll + # Multiple roll strings can be chained with semicolon + + 'roll : roll ROLLSEP roll' + global output + p[0] = p[1] + "; " + p[3] + output = p[0] + + def p_roll(self, p): + # Parse a basic roll string. + + 'roll : trial modifier comment' + global output + mods = [] + if type(p[2]) == list: + mods = p[2] + else: + mods = [p[2]] + p[0] = self.process_roll(p[1], mods, p[3]) + output = p[0] + + def p_roll_no_trials(self, p): + # Parse a roll string without trials. + + 'roll : modifier comment' + global output + mods = [] + if type(p[1]) == list: + mods = p[1] + else: + mods = [p[1]] + p[0] = self.process_roll(None, mods, p[2]) + output = p[0] + + def p_comment(self, p): + # Parse a comment. + + '''comment : TEXT + |''' + if len(p) == 2: + p[0] = p[1] + else: + p[0] = None + + def p_modifier(self, p): + # Parse a modifier on a roll string. + + '''modifier : modifier "+" modifier + | modifier "-" modifier''' + # Use append to prevent nested lists (makes dealing with this easier) + if type(p[1]) == list: + p[1].append(p[2]) + p[1].append(p[3]) + p[0] = p[1] + elif type(p[3]) == list: + p[3].insert(0, p[2]) + p[3].insert(0, p[1]) + p[0] = p[3] + else: + p[0] = [p[1], p[2], p[3]] + + def p_die(self, p): + # Return the left side before the "d", and the number of faces. + + 'modifier : left NUMBER' + p[0] = (p[1], p[2]) + + def p_die_num(self, p): + 'modifier : NUMBER' + p[0] = p[1] + + def p_left(self, p): + # Parse the number of dice we are rolling, and how many we are keeping. + 'left : keep dice' + if p[1] == None: + p[0] = [None, p[2]] + else: + p[0] = [p[1], p[2]] + + def p_left_all(self, p): + 'left : dice' + p[0] = [None, p[1]] + + def p_left_e(self, p): + 'left :' + p[0] = None + + def p_total(self, p): + 'trial : NUMBER "#"' + if len(p) > 1: + p[0] = p[1] + else: + p[0] = None + + def p_keep(self, p): + 'keep : NUMBER "/"' + if p[1] != None: + p[0] = p[1] + else: + p[0] = None + + def p_dice(self, p): + 'dice : NUMBER "d"' + p[0] = p[1] + + def p_dice_one(self, p): + 'dice : "d"' + p[0] = 1 + + def p_error(self, p): + """Raise ValueError on unparseable strings.""" + raise ValueError("Error occurred in parser") + + def get_result(self): + global output + return output + + def do_roll(self, dicestr): + """ + Roll some dice and get the result (with broken out rolls). + + Keyword arguments: + dicestr - format: + N#X/YdS+M label + N#: do the following roll N times (optional) + X/: take the top X rolls of the Y times rolled (optional) + Y : roll the die specified Y times (optional, defaults to 1) + dS: roll a S-sided die + +M: add M to the result (-M for subtraction) (optional) + """ + self.build() + yacc.parse(dicestr) + return self.get_result() From 8fcc8365e35c5c648ce96d52999a4d1d709a9e31 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Fri, 21 Jun 2019 18:07:10 -0500 Subject: [PATCH 06/21] add a dice rolling API view to the django app --- dice/urls.py | 8 ++++++++ dice/views.py | 36 ++++++++++++++++++++++++++++++++++++ dr_botzo/urls.py | 1 + 3 files changed, 45 insertions(+) create mode 100644 dice/urls.py create mode 100644 dice/views.py diff --git a/dice/urls.py b/dice/urls.py new file mode 100644 index 0000000..9ac7509 --- /dev/null +++ b/dice/urls.py @@ -0,0 +1,8 @@ +"""URL patterns for the dice views.""" +from django.urls import path + +from dice.views import rpc_roll_dice + +urlpatterns = [ + path('rpc/roll/', rpc_roll_dice, name='dice_rpc_roll_dice'), +] diff --git a/dice/views.py b/dice/views.py new file mode 100644 index 0000000..4653f04 --- /dev/null +++ b/dice/views.py @@ -0,0 +1,36 @@ +"""Views for rolling dice.""" +import json +import logging + +from rest_framework.authentication import BasicAuthentication +from rest_framework.permissions import IsAuthenticated +from rest_framework.response import Response +from rest_framework.decorators import api_view, authentication_classes, permission_classes + +from dice.roller import DiceRoller + +logger = logging.getLogger(__name__) +roller = DiceRoller() + + +@api_view(['POST']) +@authentication_classes((BasicAuthentication, )) +@permission_classes((IsAuthenticated, )) +def rpc_roll_dice(request): + """Get a dice string from the client, roll the dice, and give the result.""" + if request.method != 'POST': + return Response({'detail': "Supported method: POST."}, status=405) + + try: + roll_data = json.loads(request.body) + dice_str = roll_data['dice'] + except (json.decoder.JSONDecodeError, KeyError): + return Response({'detail': "Request must be JSON with a 'dice' parameter."}, status=400) + + try: + result_str = roller.do_roll(dice_str) + return Response({'dice': dice_str, 'result': result_str}) + except AssertionError as aex: + return Response({'detail': f"Could not roll dice: {aex}"}, status=400) + except ValueError: + return Response({'detail': f"Could not parse requested dice '{dice_str}'."}, status=400) diff --git a/dr_botzo/urls.py b/dr_botzo/urls.py index b163cf6..067163d 100644 --- a/dr_botzo/urls.py +++ b/dr_botzo/urls.py @@ -13,6 +13,7 @@ admin.autodiscover() urlpatterns = [ url(r'^$', TemplateView.as_view(template_name='index.html'), name='home'), + url(r'^dice/', include('dice.urls')), url(r'^dispatch/', include('dispatch.urls')), url(r'^itemsets/', include('facts.urls')), url(r'^karma/', include('karma.urls')), From 649a148209db694aaf4e6e2e7bcbedbe0aada767 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sat, 22 Jun 2019 11:43:30 -0500 Subject: [PATCH 07/21] don't assert on trials if they aren't provided --- dice/roller.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/dice/roller.py b/dice/roller.py index 3a06f1e..f325d9c 100644 --- a/dice/roller.py +++ b/dice/roller.py @@ -64,7 +64,8 @@ class DiceRoller(object): up to a semicolon or end of line). """ rolls = mods[0][0][1] if mods[0][0][1] else 1 - assert trials <= 10, "Too many rolls (max: 10)." + if trials: + assert trials <= 10, "Too many rolls (max: 10)." assert rolls <= 50, "Too many dice (max: 50) in roll." output = "" From 6b8dd1a645cdc8b15a48b264e4d727bae6316fe2 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sat, 22 Jun 2019 11:45:09 -0500 Subject: [PATCH 08/21] dos2unix dice/* --- dice/roller.py | 528 ++++++++++++++++++++++++------------------------- dice/urls.py | 16 +- dice/views.py | 72 +++---- 3 files changed, 308 insertions(+), 308 deletions(-) diff --git a/dice/roller.py b/dice/roller.py index f325d9c..58a7f21 100644 --- a/dice/roller.py +++ b/dice/roller.py @@ -1,264 +1,264 @@ -"""Dice rollers used by the views, bots, etc.""" -import logging -import random - -import ply.lex as lex -import ply.yacc as yacc - -logger = logging.getLogger(__name__) - - -class DiceRoller(object): - - tokens = ['NUMBER', 'TEXT', 'ROLLSEP'] - literals = ['#', '/', '+', '-', 'd'] - - t_TEXT = r'\s+[^;]+' - t_ROLLSEP = r';\s*' - - def build(self): - lex.lex(module=self) - yacc.yacc(module=self) - - def t_NUMBER(self, t): - r'\d+' - t.value = int(t.value) - return t - - def t_error(self, t): - t.lexer.skip(1) - - precedence = ( - ('left', 'ROLLSEP'), - ('left', '+', '-'), - ('right', 'd'), - ('left', '#'), - ('left', '/') - ) - - output = "" - - def roll_dice(self, keep, dice, size): - """Takes the parsed dice string for a single roll (eg 3/4d20) and performs - the actual roll. Returns a string representing the result. - """ - - a = list(range(dice)) - for i in range(dice): - a[i] = random.randint(1, size) - if keep != dice: - b = sorted(a, reverse=True) - b = b[0:keep] - else: - b = a - total = sum(b) - outstr = "[" + ",".join(str(i) for i in a) + "]" - - return (total, outstr) - - def process_roll(self, trials, mods, comment): - """Processes rolls coming from the parser. - - This generates the inputs for the roll_dice() command, and returns - the full string representing the whole current dice string (the part - up to a semicolon or end of line). - """ - rolls = mods[0][0][1] if mods[0][0][1] else 1 - if trials: - assert trials <= 10, "Too many rolls (max: 10)." - assert rolls <= 50, "Too many dice (max: 50) in roll." - - output = "" - repeat = 1 - if trials != None: - repeat = trials - for i in range(repeat): - mode = 1 - total = 0 - curr_str = "" - if i > 0: - output += ", " - for m in mods: - keep = 0 - dice = 1 - res = 0 - # if m is a tuple, then it is a die roll - # m[0] = (keep, num dice) - # m[1] = num faces on the die - if type(m) == tuple: - if m[0] != None: - if m[0][0] != None: - keep = m[0][0] - dice = m[0][1] - size = m[1] - if keep > dice or keep == 0: - keep = dice - if size < 1: - output = "# of sides for die is incorrect: %d" % size - return output - if dice < 1: - output = "# of dice is incorrect: %d" % dice - return output - res = self.roll_dice(keep, dice, size) - curr_str += "%d%s" % (res[0], res[1]) - res = res[0] - elif m == "+": - mode = 1 - curr_str += "+" - elif m == "-": - mode = -1 - curr_str += "-" - else: - res = m - curr_str += str(m) - total += mode * res - if repeat == 1: - if comment != None: - output = "%d %s (%s)" % (total, comment.strip(), curr_str) - else: - output = "%d (%s)" % (total, curr_str) - else: - output += "%d (%s)" % (total, curr_str) - if i == repeat - 1: - if comment != None: - output += " (%s)" % (comment.strip()) - return output - - def p_roll_r(self, p): - # Chain rolls together. - - # General idea I had when creating this grammar: A roll string is a chain - # of modifiers, which may be repeated for a certain number of trials. It can - # have a comment that describes the roll - # Multiple roll strings can be chained with semicolon - - 'roll : roll ROLLSEP roll' - global output - p[0] = p[1] + "; " + p[3] - output = p[0] - - def p_roll(self, p): - # Parse a basic roll string. - - 'roll : trial modifier comment' - global output - mods = [] - if type(p[2]) == list: - mods = p[2] - else: - mods = [p[2]] - p[0] = self.process_roll(p[1], mods, p[3]) - output = p[0] - - def p_roll_no_trials(self, p): - # Parse a roll string without trials. - - 'roll : modifier comment' - global output - mods = [] - if type(p[1]) == list: - mods = p[1] - else: - mods = [p[1]] - p[0] = self.process_roll(None, mods, p[2]) - output = p[0] - - def p_comment(self, p): - # Parse a comment. - - '''comment : TEXT - |''' - if len(p) == 2: - p[0] = p[1] - else: - p[0] = None - - def p_modifier(self, p): - # Parse a modifier on a roll string. - - '''modifier : modifier "+" modifier - | modifier "-" modifier''' - # Use append to prevent nested lists (makes dealing with this easier) - if type(p[1]) == list: - p[1].append(p[2]) - p[1].append(p[3]) - p[0] = p[1] - elif type(p[3]) == list: - p[3].insert(0, p[2]) - p[3].insert(0, p[1]) - p[0] = p[3] - else: - p[0] = [p[1], p[2], p[3]] - - def p_die(self, p): - # Return the left side before the "d", and the number of faces. - - 'modifier : left NUMBER' - p[0] = (p[1], p[2]) - - def p_die_num(self, p): - 'modifier : NUMBER' - p[0] = p[1] - - def p_left(self, p): - # Parse the number of dice we are rolling, and how many we are keeping. - 'left : keep dice' - if p[1] == None: - p[0] = [None, p[2]] - else: - p[0] = [p[1], p[2]] - - def p_left_all(self, p): - 'left : dice' - p[0] = [None, p[1]] - - def p_left_e(self, p): - 'left :' - p[0] = None - - def p_total(self, p): - 'trial : NUMBER "#"' - if len(p) > 1: - p[0] = p[1] - else: - p[0] = None - - def p_keep(self, p): - 'keep : NUMBER "/"' - if p[1] != None: - p[0] = p[1] - else: - p[0] = None - - def p_dice(self, p): - 'dice : NUMBER "d"' - p[0] = p[1] - - def p_dice_one(self, p): - 'dice : "d"' - p[0] = 1 - - def p_error(self, p): - """Raise ValueError on unparseable strings.""" - raise ValueError("Error occurred in parser") - - def get_result(self): - global output - return output - - def do_roll(self, dicestr): - """ - Roll some dice and get the result (with broken out rolls). - - Keyword arguments: - dicestr - format: - N#X/YdS+M label - N#: do the following roll N times (optional) - X/: take the top X rolls of the Y times rolled (optional) - Y : roll the die specified Y times (optional, defaults to 1) - dS: roll a S-sided die - +M: add M to the result (-M for subtraction) (optional) - """ - self.build() - yacc.parse(dicestr) - return self.get_result() +"""Dice rollers used by the views, bots, etc.""" +import logging +import random + +import ply.lex as lex +import ply.yacc as yacc + +logger = logging.getLogger(__name__) + + +class DiceRoller(object): + + tokens = ['NUMBER', 'TEXT', 'ROLLSEP'] + literals = ['#', '/', '+', '-', 'd'] + + t_TEXT = r'\s+[^;]+' + t_ROLLSEP = r';\s*' + + def build(self): + lex.lex(module=self) + yacc.yacc(module=self) + + def t_NUMBER(self, t): + r'\d+' + t.value = int(t.value) + return t + + def t_error(self, t): + t.lexer.skip(1) + + precedence = ( + ('left', 'ROLLSEP'), + ('left', '+', '-'), + ('right', 'd'), + ('left', '#'), + ('left', '/') + ) + + output = "" + + def roll_dice(self, keep, dice, size): + """Takes the parsed dice string for a single roll (eg 3/4d20) and performs + the actual roll. Returns a string representing the result. + """ + + a = list(range(dice)) + for i in range(dice): + a[i] = random.randint(1, size) + if keep != dice: + b = sorted(a, reverse=True) + b = b[0:keep] + else: + b = a + total = sum(b) + outstr = "[" + ",".join(str(i) for i in a) + "]" + + return (total, outstr) + + def process_roll(self, trials, mods, comment): + """Processes rolls coming from the parser. + + This generates the inputs for the roll_dice() command, and returns + the full string representing the whole current dice string (the part + up to a semicolon or end of line). + """ + rolls = mods[0][0][1] if mods[0][0][1] else 1 + if trials: + assert trials <= 10, "Too many rolls (max: 10)." + assert rolls <= 50, "Too many dice (max: 50) in roll." + + output = "" + repeat = 1 + if trials != None: + repeat = trials + for i in range(repeat): + mode = 1 + total = 0 + curr_str = "" + if i > 0: + output += ", " + for m in mods: + keep = 0 + dice = 1 + res = 0 + # if m is a tuple, then it is a die roll + # m[0] = (keep, num dice) + # m[1] = num faces on the die + if type(m) == tuple: + if m[0] != None: + if m[0][0] != None: + keep = m[0][0] + dice = m[0][1] + size = m[1] + if keep > dice or keep == 0: + keep = dice + if size < 1: + output = "# of sides for die is incorrect: %d" % size + return output + if dice < 1: + output = "# of dice is incorrect: %d" % dice + return output + res = self.roll_dice(keep, dice, size) + curr_str += "%d%s" % (res[0], res[1]) + res = res[0] + elif m == "+": + mode = 1 + curr_str += "+" + elif m == "-": + mode = -1 + curr_str += "-" + else: + res = m + curr_str += str(m) + total += mode * res + if repeat == 1: + if comment != None: + output = "%d %s (%s)" % (total, comment.strip(), curr_str) + else: + output = "%d (%s)" % (total, curr_str) + else: + output += "%d (%s)" % (total, curr_str) + if i == repeat - 1: + if comment != None: + output += " (%s)" % (comment.strip()) + return output + + def p_roll_r(self, p): + # Chain rolls together. + + # General idea I had when creating this grammar: A roll string is a chain + # of modifiers, which may be repeated for a certain number of trials. It can + # have a comment that describes the roll + # Multiple roll strings can be chained with semicolon + + 'roll : roll ROLLSEP roll' + global output + p[0] = p[1] + "; " + p[3] + output = p[0] + + def p_roll(self, p): + # Parse a basic roll string. + + 'roll : trial modifier comment' + global output + mods = [] + if type(p[2]) == list: + mods = p[2] + else: + mods = [p[2]] + p[0] = self.process_roll(p[1], mods, p[3]) + output = p[0] + + def p_roll_no_trials(self, p): + # Parse a roll string without trials. + + 'roll : modifier comment' + global output + mods = [] + if type(p[1]) == list: + mods = p[1] + else: + mods = [p[1]] + p[0] = self.process_roll(None, mods, p[2]) + output = p[0] + + def p_comment(self, p): + # Parse a comment. + + '''comment : TEXT + |''' + if len(p) == 2: + p[0] = p[1] + else: + p[0] = None + + def p_modifier(self, p): + # Parse a modifier on a roll string. + + '''modifier : modifier "+" modifier + | modifier "-" modifier''' + # Use append to prevent nested lists (makes dealing with this easier) + if type(p[1]) == list: + p[1].append(p[2]) + p[1].append(p[3]) + p[0] = p[1] + elif type(p[3]) == list: + p[3].insert(0, p[2]) + p[3].insert(0, p[1]) + p[0] = p[3] + else: + p[0] = [p[1], p[2], p[3]] + + def p_die(self, p): + # Return the left side before the "d", and the number of faces. + + 'modifier : left NUMBER' + p[0] = (p[1], p[2]) + + def p_die_num(self, p): + 'modifier : NUMBER' + p[0] = p[1] + + def p_left(self, p): + # Parse the number of dice we are rolling, and how many we are keeping. + 'left : keep dice' + if p[1] == None: + p[0] = [None, p[2]] + else: + p[0] = [p[1], p[2]] + + def p_left_all(self, p): + 'left : dice' + p[0] = [None, p[1]] + + def p_left_e(self, p): + 'left :' + p[0] = None + + def p_total(self, p): + 'trial : NUMBER "#"' + if len(p) > 1: + p[0] = p[1] + else: + p[0] = None + + def p_keep(self, p): + 'keep : NUMBER "/"' + if p[1] != None: + p[0] = p[1] + else: + p[0] = None + + def p_dice(self, p): + 'dice : NUMBER "d"' + p[0] = p[1] + + def p_dice_one(self, p): + 'dice : "d"' + p[0] = 1 + + def p_error(self, p): + """Raise ValueError on unparseable strings.""" + raise ValueError("Error occurred in parser") + + def get_result(self): + global output + return output + + def do_roll(self, dicestr): + """ + Roll some dice and get the result (with broken out rolls). + + Keyword arguments: + dicestr - format: + N#X/YdS+M label + N#: do the following roll N times (optional) + X/: take the top X rolls of the Y times rolled (optional) + Y : roll the die specified Y times (optional, defaults to 1) + dS: roll a S-sided die + +M: add M to the result (-M for subtraction) (optional) + """ + self.build() + yacc.parse(dicestr) + return self.get_result() diff --git a/dice/urls.py b/dice/urls.py index 9ac7509..f2e4cb7 100644 --- a/dice/urls.py +++ b/dice/urls.py @@ -1,8 +1,8 @@ -"""URL patterns for the dice views.""" -from django.urls import path - -from dice.views import rpc_roll_dice - -urlpatterns = [ - path('rpc/roll/', rpc_roll_dice, name='dice_rpc_roll_dice'), -] +"""URL patterns for the dice views.""" +from django.urls import path + +from dice.views import rpc_roll_dice + +urlpatterns = [ + path('rpc/roll/', rpc_roll_dice, name='dice_rpc_roll_dice'), +] diff --git a/dice/views.py b/dice/views.py index 4653f04..3c9f9dc 100644 --- a/dice/views.py +++ b/dice/views.py @@ -1,36 +1,36 @@ -"""Views for rolling dice.""" -import json -import logging - -from rest_framework.authentication import BasicAuthentication -from rest_framework.permissions import IsAuthenticated -from rest_framework.response import Response -from rest_framework.decorators import api_view, authentication_classes, permission_classes - -from dice.roller import DiceRoller - -logger = logging.getLogger(__name__) -roller = DiceRoller() - - -@api_view(['POST']) -@authentication_classes((BasicAuthentication, )) -@permission_classes((IsAuthenticated, )) -def rpc_roll_dice(request): - """Get a dice string from the client, roll the dice, and give the result.""" - if request.method != 'POST': - return Response({'detail': "Supported method: POST."}, status=405) - - try: - roll_data = json.loads(request.body) - dice_str = roll_data['dice'] - except (json.decoder.JSONDecodeError, KeyError): - return Response({'detail': "Request must be JSON with a 'dice' parameter."}, status=400) - - try: - result_str = roller.do_roll(dice_str) - return Response({'dice': dice_str, 'result': result_str}) - except AssertionError as aex: - return Response({'detail': f"Could not roll dice: {aex}"}, status=400) - except ValueError: - return Response({'detail': f"Could not parse requested dice '{dice_str}'."}, status=400) +"""Views for rolling dice.""" +import json +import logging + +from rest_framework.authentication import BasicAuthentication +from rest_framework.permissions import IsAuthenticated +from rest_framework.response import Response +from rest_framework.decorators import api_view, authentication_classes, permission_classes + +from dice.roller import DiceRoller + +logger = logging.getLogger(__name__) +roller = DiceRoller() + + +@api_view(['POST']) +@authentication_classes((BasicAuthentication, )) +@permission_classes((IsAuthenticated, )) +def rpc_roll_dice(request): + """Get a dice string from the client, roll the dice, and give the result.""" + if request.method != 'POST': + return Response({'detail': "Supported method: POST."}, status=405) + + try: + roll_data = json.loads(request.body) + dice_str = roll_data['dice'] + except (json.decoder.JSONDecodeError, KeyError): + return Response({'detail': "Request must be JSON with a 'dice' parameter."}, status=400) + + try: + result_str = roller.do_roll(dice_str) + return Response({'dice': dice_str, 'result': result_str}) + except AssertionError as aex: + return Response({'detail': f"Could not roll dice: {aex}"}, status=400) + except ValueError: + return Response({'detail': f"Could not parse requested dice '{dice_str}'."}, status=400) From c2aa3df13f11b7fd89c987ef1c5f92ca8dbf334a Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sat, 29 Jun 2019 09:23:02 -0500 Subject: [PATCH 09/21] fix some '!= None' checks, rewrite as 'is not None' --- dice/roller.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/dice/roller.py b/dice/roller.py index 58a7f21..a03c722 100644 --- a/dice/roller.py +++ b/dice/roller.py @@ -70,7 +70,7 @@ class DiceRoller(object): output = "" repeat = 1 - if trials != None: + if trials is not None: repeat = trials for i in range(repeat): mode = 1 @@ -86,8 +86,8 @@ class DiceRoller(object): # m[0] = (keep, num dice) # m[1] = num faces on the die if type(m) == tuple: - if m[0] != None: - if m[0][0] != None: + if m[0] is not None: + if m[0][0] is not None: keep = m[0][0] dice = m[0][1] size = m[1] @@ -113,14 +113,14 @@ class DiceRoller(object): curr_str += str(m) total += mode * res if repeat == 1: - if comment != None: + if comment is not None: output = "%d %s (%s)" % (total, comment.strip(), curr_str) else: output = "%d (%s)" % (total, curr_str) else: output += "%d (%s)" % (total, curr_str) if i == repeat - 1: - if comment != None: + if comment is not None: output += " (%s)" % (comment.strip()) return output From b917f78ca53a0cb1744e787ddd764d29cb600975 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sat, 29 Jun 2019 09:23:35 -0500 Subject: [PATCH 10/21] replace dice sanity checks as asserts --- dice/roller.py | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/dice/roller.py b/dice/roller.py index a03c722..a65192c 100644 --- a/dice/roller.py +++ b/dice/roller.py @@ -93,12 +93,8 @@ class DiceRoller(object): size = m[1] if keep > dice or keep == 0: keep = dice - if size < 1: - output = "# of sides for die is incorrect: %d" % size - return output - if dice < 1: - output = "# of dice is incorrect: %d" % dice - return output + assert size >= 1, f"Die must have at least one side." + assert dice >= 1, f"At least one die must be rolled." res = self.roll_dice(keep, dice, size) curr_str += "%d%s" % (res[0], res[1]) res = res[0] From abce0262f3cf1395cc6a78af7ca342cb3acd34e6 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sat, 29 Jun 2019 09:24:16 -0500 Subject: [PATCH 11/21] provide dice_str in exceptions, where applicable --- dice/views.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dice/views.py b/dice/views.py index 3c9f9dc..bfccd81 100644 --- a/dice/views.py +++ b/dice/views.py @@ -31,6 +31,6 @@ def rpc_roll_dice(request): result_str = roller.do_roll(dice_str) return Response({'dice': dice_str, 'result': result_str}) except AssertionError as aex: - return Response({'detail': f"Could not roll dice: {aex}"}, status=400) + return Response({'detail': f"Could not roll dice: {aex}", 'dice': dice_str}, status=400) except ValueError: - return Response({'detail': f"Could not parse requested dice '{dice_str}'."}, status=400) + return Response({'detail': f"Could not parse requested dice '{dice_str}'.", 'dice': dice_str}, status=400) From d34fb18949f2dc1b1c3c161e5d0c0fa856b9c822 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sat, 29 Jun 2019 09:25:57 -0500 Subject: [PATCH 12/21] rename 'home' view as 'index', fixes DEBUG page behavior --- dr_botzo/urls.py | 2 +- templates/base.html | 2 +- templates/index.html | 2 +- templates/registration/registration_base.html | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/dr_botzo/urls.py b/dr_botzo/urls.py index 067163d..e0a8a41 100644 --- a/dr_botzo/urls.py +++ b/dr_botzo/urls.py @@ -11,7 +11,7 @@ admin.sites.site = admin.site admin.autodiscover() urlpatterns = [ - url(r'^$', TemplateView.as_view(template_name='index.html'), name='home'), + url(r'^$', TemplateView.as_view(template_name='index.html'), name='index'), url(r'^dice/', include('dice.urls')), url(r'^dispatch/', include('dispatch.urls')), diff --git a/templates/base.html b/templates/base.html index 6a5cddc..e9c4bc4 100644 --- a/templates/base.html +++ b/templates/base.html @@ -15,7 +15,7 @@
{% block navbarbrand %} - {{ site.domain }} + {{ site.domain }} {% endblock %} diff --git a/templates/index.html b/templates/index.html index b969381..d1c6c62 100644 --- a/templates/index.html +++ b/templates/index.html @@ -3,7 +3,7 @@ {% block title %}{{ site.domain }}{% endblock %} {% block navbarbrand %} -{{ site.domain }} +{{ site.domain }} {% endblock %} {% block content %} diff --git a/templates/registration/registration_base.html b/templates/registration/registration_base.html index 345a4c9..16849d1 100644 --- a/templates/registration/registration_base.html +++ b/templates/registration/registration_base.html @@ -5,7 +5,7 @@ {% endblock %} {% block navbarbrand %} -{{ site.domain }} +{{ site.domain }} {% endblock %} {% block content %} From 9e4bc595a4267a3806d53251d7755a424729b8f6 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Thu, 19 Sep 2019 00:12:36 -0500 Subject: [PATCH 13/21] add markov RPC method for generating a line from a context --- markov/lib.py | 4 ++++ markov/urls.py | 11 ++++++----- markov/views.py | 39 ++++++++++++++++++++++++++++++++++++--- 3 files changed, 46 insertions(+), 8 deletions(-) diff --git a/markov/lib.py b/markov/lib.py index 9e7243a..958541a 100644 --- a/markov/lib.py +++ b/markov/lib.py @@ -164,6 +164,10 @@ def get_word_out_of_states(states, backwards=False): new_word = '' running = 0 count_sum = states.aggregate(Sum('count'))['count__sum'] + if not count_sum: + # this being None probably means there's no data for this context + raise ValueError("no markov states to generate from") + hit = random.randint(0, count_sum) log.debug("sum: {0:d} hit: {1:d}".format(count_sum, hit)) diff --git a/markov/urls.py b/markov/urls.py index aeec473..1fcb1a9 100644 --- a/markov/urls.py +++ b/markov/urls.py @@ -1,11 +1,12 @@ """URL patterns for markov stuff.""" - -from django.conf.urls import url +from django.urls import path from django.views.generic import TemplateView -from markov.views import context_index +from markov.views import context_index, rpc_generate_line_for_context urlpatterns = [ - url(r'^$', TemplateView.as_view(template_name='index.html'), name='markov_index'), - url(r'^context/(?P\d+)/$', context_index, name='markov_context_index'), + path('', TemplateView.as_view(template_name='index.html'), name='markov_index'), + path('context//', context_index, name='markov_context_index'), + + path('rpc/context//generate/', rpc_generate_line_for_context, name='markov_rpc_generate_line'), ] diff --git a/markov/views.py b/markov/views.py index 2975866..5e3f87b 100644 --- a/markov/views.py +++ b/markov/views.py @@ -1,16 +1,19 @@ """Manipulate Markov data via the Django site.""" - +import json import logging import time from django.http import HttpResponse from django.shortcuts import get_object_or_404, render +from rest_framework.authentication import BasicAuthentication +from rest_framework.permissions import IsAuthenticated +from rest_framework.response import Response +from rest_framework.decorators import api_view, authentication_classes, permission_classes import markov.lib as markovlib from markov.models import MarkovContext - -log = logging.getLogger('markov.views') +logger = logging.getLogger(__name__) def index(request): @@ -28,3 +31,33 @@ def context_index(request, context_id): end_t = time.time() return render(request, 'markov/context.html', {'chain': chain, 'context': context, 'elapsed': end_t - start_t}) + + +@api_view(['POST']) +@authentication_classes((BasicAuthentication, )) +@permission_classes((IsAuthenticated, )) +def rpc_generate_line_for_context(request, context): + """Generate a line from a given context, with optional topics included.""" + if request.method != 'POST': + return Response({'detail': "Supported method: POST."}, status=405) + + topics = None + try: + if request.body: + markov_data = json.loads(request.body) + topics = markov_data.get('topics', []) + except (json.decoder.JSONDecodeError, KeyError): + return Response({'detail': "Request body, if provided, must be JSON with an optional 'topics' parameter."}, + status=400) + + context_id = markovlib.get_or_create_target_context(context) + try: + generated_words = markovlib.generate_line(context_id, topics) + except ValueError as vex: + return Response({'detail': f"Could not generate line: {vex}", 'context': context, 'topics': topics}, + status=400) + else: + return Response({ + 'context': context, 'topics': topics, + 'generated_line': ' '.join(generated_words), 'generated_words': generated_words + }) From 802072caed76c82b854ad82c6f556227ab285851 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Thu, 19 Sep 2019 00:21:18 -0500 Subject: [PATCH 14/21] add markov RPC method for learning a line --- markov/urls.py | 3 ++- markov/views.py | 19 +++++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/markov/urls.py b/markov/urls.py index 1fcb1a9..946becf 100644 --- a/markov/urls.py +++ b/markov/urls.py @@ -2,11 +2,12 @@ from django.urls import path from django.views.generic import TemplateView -from markov.views import context_index, rpc_generate_line_for_context +from markov.views import context_index, rpc_generate_line_for_context, rpc_learn_line_for_context urlpatterns = [ path('', TemplateView.as_view(template_name='index.html'), name='markov_index'), path('context//', context_index, name='markov_context_index'), path('rpc/context//generate/', rpc_generate_line_for_context, name='markov_rpc_generate_line'), + path('rpc/context//learn/', rpc_learn_line_for_context, name='markov_rpc_learn_line'), ] diff --git a/markov/views.py b/markov/views.py index 5e3f87b..ab7958e 100644 --- a/markov/views.py +++ b/markov/views.py @@ -61,3 +61,22 @@ def rpc_generate_line_for_context(request, context): 'context': context, 'topics': topics, 'generated_line': ' '.join(generated_words), 'generated_words': generated_words }) + + +@api_view(['POST']) +@authentication_classes((BasicAuthentication, )) +@permission_classes((IsAuthenticated, )) +def rpc_learn_line_for_context(request, context): + """Learn a line for a given context.""" + if request.method != 'POST': + return Response({'detail': "Supported method: POST."}, status=405) + + try: + markov_data = json.loads(request.body) + line = markov_data.get('line', []) + except (json.decoder.JSONDecodeError, KeyError): + return Response({'detail': "Request body must be JSON with a 'line' parameter."}, status=400) + + context_id = markovlib.get_or_create_target_context(context) + markovlib.learn_line(line, context_id) + return Response({'status': "OK", 'context': context, 'line': line}) From 31758b80b674b0adc5e8732bb8ed004bb12c4998 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sat, 5 Oct 2019 10:36:28 -0500 Subject: [PATCH 15/21] weather: start rewriting weather plugin to use wttr.in --- weather/ircplugin.py | 19 +--- weather/lib.py | 224 ++++++++----------------------------------- 2 files changed, 41 insertions(+), 202 deletions(-) diff --git a/weather/ircplugin.py b/weather/ircplugin.py index 226b674..4b931d5 100644 --- a/weather/ircplugin.py +++ b/weather/ircplugin.py @@ -2,7 +2,7 @@ import logging from ircbot.lib import Plugin -from weather.lib import get_conditions_for_query, get_forecast_for_query +from weather.lib import weather_summary log = logging.getLogger('weather.ircplugin') @@ -28,27 +28,12 @@ class Weather(Plugin): super(Weather, self).stop() def handle_weather(self, connection, event, match): - """Handle IRC input for a weather queries.""" - - # see if there was a specific command given in the query, first query = match.group(1) queryitems = query.split(" ") if len(queryitems) <= 0: return - # search for commands - if queryitems[0] == 'conditions': - # current weather query - results = get_conditions_for_query(queryitems[1:]) - return self.bot.reply(event, results) - elif queryitems[0] == 'forecast': - # forecast query - results = get_forecast_for_query(queryitems[1:]) - return self.bot.reply(event, results) - else: - # assume they wanted current weather - results = get_conditions_for_query(queryitems) - return self.bot.reply(event, results) + return self.bot.reply(event, weather_summary(queryitems[0])) plugin = Weather diff --git a/weather/lib.py b/weather/lib.py index 86d73cc..afa0d12 100644 --- a/weather/lib.py +++ b/weather/lib.py @@ -1,196 +1,50 @@ # coding: utf-8 - +"""Get results of weather queries.""" import logging -import re import requests -from django.conf import settings +logger = logging.getLogger(__name__) -wu_base_url = 'http://api.wunderground.com/api/{0:s}/'.format(settings.WEATHER_WEATHER_UNDERGROUND_API_KEY) -log = logging.getLogger('weather.lib') +def query_wttr_in(query): + """Hit the wttr.in JSON API with the provided query.""" + logger.info(f"about to query wttr.in with '{query}") + response = requests.get('http://wttr.in/{query}?format=j1') + response.raise_for_status() + + weather_info = response.json() + logger.debug(f"results: {weather_info}") + return weather_info -def get_conditions_for_query(queryitems): - """Make a wunderground conditions call, return as string.""" +def weather_summary(query): + """Create a more consumable version of the weather report.""" + weather_info = query_wttr_in(query) - # recombine the query into a string - query = ' '.join(queryitems) - query = query.replace(' ', '_') + # get some common/nested stuff once now + current = weather_info['current_condition'][0] + weather_desc = current['weatherDesc'][0] if 'weatherDesc' in current else {} + today_forecast = weather_info['weather'][0] + tomorrow_forecast = weather_info['weather'][1] + day_after_tomorrow_forecast = weather_info['weather'][2] - try: - url = wu_base_url + ('{0:s}/q/{1:s}.json'.format('conditions', query)) - log.debug("calling %s", url) - resp = requests.get(url) - condition_data = resp.json() - except IOError as e: - log.error("error while making conditions query") - log.exception(e) - raise + summary = { + 'location': query, + 'current': { + 'description': weather_desc.get('value'), + 'temp_C': f"{current.get('temp_C')}°C", + 'temp_F': f"{current.get('temp_F')}°F", + 'feels_like_temp_C': f"{current.get('FeelsLikeC')}°C", + 'feels_like_temp_F': f"{current.get('FeelsLikeF')}°F", + 'cloud_cover': f"{current.get('cloudcover')}%", + 'humidity': f"{current.get('humidity')}%", + 'precipitation': f"{current.get('precipMM')} mm", + 'visibility': f"{current.get('visibility')} mi", + 'wind_speed': f"{current.get('windspeedMiles')} MPH", + 'wind_direction': f"{current.get('winddir16Point')}", + 'pressure': f"{current.get('pressure')} mb", + 'uv_index': f"{current.get('uvIndex')}", + }, + } - # condition data is loaded. the rest of this is obviously specific to - # http://www.wunderground.com/weather/api/d/docs?d=data/conditions - log.debug(condition_data) - - try: - # just see if we have current_observation data - current = condition_data['current_observation'] - except KeyError as e: - # ok, try to see if the ambiguous results stuff will help - log.debug(e) - log.debug("potentially ambiguous results, checking") - try: - results = condition_data['response']['results'] - reply = "Multiple results, try one of the following zmw codes:" - for res in results[:-1]: - q = res['l'].strip('/q/') - reply += " {0:s} ({1:s}, {2:s}),".format(q, res['name'], res['country_name']) - q = results[-1]['l'].strip('/q/') - reply += " or {0:s} ({1:s}, {2:s}).".format(q, results[-1]['name'], results[-1]['country_name']) - return reply - except KeyError as e: - # now we really know something is wrong - log.error("error or bad query in conditions lookup") - log.exception(e) - return "No results." - else: - try: - location = current['display_location']['full'] - reply = "Conditions for {0:s}: ".format(location) - - weather_str = current['weather'] - if weather_str != '': - reply += "{0:s}, ".format(weather_str) - - temp_f = current['temp_f'] - temp_c = current['temp_c'] - temp_str = current['temperature_string'] - if temp_f != '' and temp_c != '': - reply += "{0:.1f}°F ({1:.1f}°C)".format(temp_f, temp_c) - elif temp_str != '': - reply += "{0:s}".format(temp_str) - - # append feels like if we have it - feelslike_f = current['feelslike_f'] - feelslike_c = current['feelslike_c'] - feelslike_str = current['feelslike_string'] - if feelslike_f != '' and feelslike_c != '': - reply += ", feels like {0:s}°F ({1:s}°C)".format(feelslike_f, feelslike_c) - elif feelslike_str != '': - reply += ", feels like {0:s}".format(feelslike_str) - - # whether this is current or current + feelslike, terminate sentence - reply += ". " - - humidity_str = current['relative_humidity'] - if humidity_str != '': - reply += "Humidity: {0:s}. ".format(humidity_str) - - wind_str = current['wind_string'] - if wind_str != '': - reply += "Wind: {0:s}. ".format(wind_str) - - pressure_in = current['pressure_in'] - pressure_trend = current['pressure_trend'] - if pressure_in != '': - reply += "Pressure: {0:s}\"".format(pressure_in) - if pressure_trend != '': - reply += " and {0:s}".format("dropping" if pressure_trend == '-' else "rising") - reply += ". " - - heat_index_str = current['heat_index_string'] - if heat_index_str != '' and heat_index_str != 'NA': - reply += "Heat index: {0:s}. ".format(heat_index_str) - - windchill_str = current['windchill_string'] - if windchill_str != '' and windchill_str != 'NA': - reply += "Wind chill: {0:s}. ".format(windchill_str) - - visibility_mi = current['visibility_mi'] - if visibility_mi != '': - reply += "Visibility: {0:s} miles. ".format(visibility_mi) - - precip_in = current['precip_today_in'] - if precip_in != '': - reply += "Precipitation today: {0:s}\". ".format(precip_in) - - observation_time = current['observation_time'] - if observation_time != '': - reply += "{0:s}. ".format(observation_time) - - return _prettify_weather_strings(reply.rstrip()) - except KeyError as e: - log.error("error or unexpected results in conditions reply") - log.exception(e) - return "Error parsing results." - - -def get_forecast_for_query(queryitems): - """Make a wunderground forecast call, return as string.""" - - # recombine the query into a string - query = ' '.join(queryitems) - query = query.replace(' ', '_') - - try: - url = wu_base_url + ('{0:s}/q/{1:s}.json'.format('forecast', query)) - resp = requests.get(url) - forecast_data = resp.json() - except IOError as e: - log.error("error while making forecast query") - log.exception(e) - raise - - # forecast data is loaded. the rest of this is obviously specific to - # http://www.wunderground.com/weather/api/d/docs?d=data/forecast - log.debug(forecast_data) - - try: - # just see if we have forecast data - forecasts = forecast_data['forecast']['txt_forecast'] - except KeyError as e: - # ok, try to see if the ambiguous results stuff will help - log.debug(e) - log.debug("potentially ambiguous results, checking") - try: - results = forecast_data['response']['results'] - reply = "Multiple results, try one of the following zmw codes:" - for res in results[:-1]: - q = res['l'].strip('/q/') - reply += " {0:s} ({1:s}, {2:s}),".format(q, res['name'], - res['country_name']) - q = results[-1]['l'].strip('/q/') - reply += " or {0:s} ({1:s}, {2:s}).".format(q, results[-1]['name'], - results[-1]['country_name']) - return reply - except KeyError as e: - # now we really know something is wrong - log.error("error or bad query in forecast lookup") - log.exception(e) - return "No results." - else: - try: - reply = "Forecast: " - for forecast in forecasts['forecastday'][0:5]: - reply += "{0:s}: {1:s} ".format(forecast['title'], - forecast['fcttext']) - - return _prettify_weather_strings(reply.rstrip()) - except KeyError as e: - log.error("error or unexpected results in forecast reply") - log.exception(e) - return "Error parsing results." - - -def _prettify_weather_strings(weather_str): - """ - Clean up output strings. - - For example, turn 32F into 32°F in input string. - - Input: - weather_str --- the string to clean up - - """ - - return re.sub(r'(\d+)\s*([FC])', r'\1°\2', weather_str) + return summary From b42d0ac0e9ca4d4420d385da0f93ef03f36ee980 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sat, 5 Oct 2019 11:34:28 -0500 Subject: [PATCH 16/21] pin irc==15.0.6 in requirements --- requirements-dev.txt | 10 ++++------ requirements.in | 2 +- requirements.txt | 6 ++---- 3 files changed, 7 insertions(+), 11 deletions(-) diff --git a/requirements-dev.txt b/requirements-dev.txt index 1704e2e..ae2333c 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -17,9 +17,8 @@ djangorestframework==3.9.4 dodgy==0.1.9 # via prospector future==0.17.1 # via parsedatetime idna==2.8 # via requests -importlib-metadata==0.18 # via irc inflect==2.1.0 # via jaraco.itertools -irc==17.1 +irc==15.0.6 isort==4.3.20 # via pylint jaraco.classes==2.0 # via jaraco.collections jaraco.collections==2.0 # via irc @@ -35,7 +34,7 @@ more-itertools==7.0.0 # via irc, jaraco.functools, jaraco.itertools oauthlib==3.0.1 # via requests-oauthlib parsedatetime==2.4 pep8-naming==0.4.1 # via prospector -pip-tools==3.8.0 +pip-tools==4.1.0 ply==3.11 prospector==1.1.6.4 pycodestyle==2.4.0 # via prospector @@ -55,7 +54,7 @@ requests-oauthlib==1.2.0 # via twython requests==2.22.0 # via python-gitlab, requests-oauthlib, twython requirements-detector==0.6 # via prospector setoptconf==0.2.0 # via prospector -six==1.12.0 # via astroid, django-extensions, jaraco.classes, jaraco.collections, jaraco.itertools, jaraco.logging, jaraco.stream, logilab-common, pip-tools, pydocstyle, python-dateutil, python-gitlab, tempora +six==1.12.0 # via astroid, django-extensions, irc, jaraco.classes, jaraco.collections, jaraco.itertools, jaraco.logging, jaraco.stream, logilab-common, pip-tools, pydocstyle, python-dateutil, python-gitlab, tempora snowballstemmer==1.2.1 # via pydocstyle sqlparse==0.3.0 # via django tempora==1.14.1 # via irc, jaraco.logging @@ -63,7 +62,6 @@ twython==3.7.0 typed-ast==1.4.0 # via astroid urllib3==1.25.3 # via requests wrapt==1.11.2 # via astroid -zipp==0.5.1 # via importlib-metadata # The following packages are considered to be unsafe in a requirements file: -# setuptools==41.0.1 # via logilab-common +# setuptools==41.2.0 # via logilab-common diff --git a/requirements.in b/requirements.in index dd0d320..5f3fee0 100644 --- a/requirements.in +++ b/requirements.in @@ -4,7 +4,7 @@ django-bootstrap3 # bootstrap layout django-extensions # more commands django-registration-redux # registration views/forms djangorestframework # dispatch WS API -irc # core +irc==15.0.6 # core, pinned until I can bother to update --- 17.x has API changes parsedatetime # relative date stuff in countdown ply # dice lex/yacc compiler python-dateutil # countdown relative math diff --git a/requirements.txt b/requirements.txt index 0a9d80a..7cfadb5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -14,9 +14,8 @@ django==2.2.2 djangorestframework==3.9.4 future==0.17.1 # via parsedatetime idna==2.8 # via requests -importlib-metadata==0.18 # via irc inflect==2.1.0 # via jaraco.itertools -irc==17.1 +irc==15.0.6 jaraco.classes==2.0 # via jaraco.collections jaraco.collections==2.0 # via irc jaraco.functools==2.0 # via irc, jaraco.text, tempora @@ -34,9 +33,8 @@ python-mpd2==1.0.0 pytz==2019.1 requests-oauthlib==1.2.0 # via twython requests==2.22.0 # via python-gitlab, requests-oauthlib, twython -six==1.12.0 # via django-extensions, jaraco.classes, jaraco.collections, jaraco.itertools, jaraco.logging, jaraco.stream, python-dateutil, python-gitlab, tempora +six==1.12.0 # via django-extensions, irc, jaraco.classes, jaraco.collections, jaraco.itertools, jaraco.logging, jaraco.stream, python-dateutil, python-gitlab, tempora sqlparse==0.3.0 # via django tempora==1.14.1 # via irc, jaraco.logging twython==3.7.0 urllib3==1.25.3 # via requests -zipp==0.5.1 # via importlib-metadata From 56d0e26c6d3802092f2edc60b9c1babab35f4748 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sun, 6 Oct 2019 09:13:51 -0500 Subject: [PATCH 17/21] reimplement !weather in the IRC bot --- weather/ircplugin.py | 22 +++++++++++++++++++++- weather/lib.py | 39 +++++++++++++++++++++++++++++++++++++-- 2 files changed, 58 insertions(+), 3 deletions(-) diff --git a/weather/ircplugin.py b/weather/ircplugin.py index 4b931d5..0d88645 100644 --- a/weather/ircplugin.py +++ b/weather/ircplugin.py @@ -33,7 +33,27 @@ class Weather(Plugin): if len(queryitems) <= 0: return - return self.bot.reply(event, weather_summary(queryitems[0])) + weather = weather_summary(queryitems[0]) + weather_output = (f"Weather in {weather['location']}: {weather['current']['description']}. " + f"{weather['current']['temp_F']}/{weather['current']['temp_C']}, " + f"feels like {weather['current']['feels_like_temp_F']}/{weather['current']['feels_like_temp_C']}. " + f"Wind {weather['current']['wind_speed']} from the {weather['current']['wind_direction']}. " + f"Visibility {weather['current']['visibility']}. " + f"Precipitation {weather['current']['precipitation']}. " + f"Pressure {weather['current']['pressure']}. " + f"Cloud cover {weather['current']['cloud_cover']}. UV index {weather['current']['uv_index']}. " + f"Today: {weather['today_forecast']['noteworthy']}, " + f"High {weather['today_forecast']['high_F']}/{weather['today_forecast']['high_C']}, " + f"Low {weather['today_forecast']['low_F']}/{weather['today_forecast']['low_C']}. " + f"Tomorrow: {weather['tomorrow_forecast']['noteworthy']}, " + f"High {weather['tomorrow_forecast']['high_F']}/{weather['tomorrow_forecast']['high_C']}, " + f"Low {weather['tomorrow_forecast']['low_F']}/{weather['tomorrow_forecast']['low_C']}. " + f"Day after tomorrow: {weather['day_after_tomorrow_forecast']['noteworthy']}, " + f"High {weather['day_after_tomorrow_forecast']['high_F']}/{weather['day_after_tomorrow_forecast']['high_C']}, " + f"Low {weather['day_after_tomorrow_forecast']['low_F']}/{weather['day_after_tomorrow_forecast']['low_C']}." + ) + + return self.bot.reply(event, weather_output) plugin = Weather diff --git a/weather/lib.py b/weather/lib.py index afa0d12..18748bb 100644 --- a/weather/lib.py +++ b/weather/lib.py @@ -19,6 +19,7 @@ def query_wttr_in(query): def weather_summary(query): """Create a more consumable version of the weather report.""" + logger.info(f"assembling weather summary for '{query}") weather_info = query_wttr_in(query) # get some common/nested stuff once now @@ -28,6 +29,18 @@ def weather_summary(query): tomorrow_forecast = weather_info['weather'][1] day_after_tomorrow_forecast = weather_info['weather'][2] + today_notes = [{'code': int(item['weatherCode']), 'desc': item['weatherDesc'][0]['value'] } + for item in today_forecast['hourly']] + today_noteworthy = sorted(today_notes, key=lambda i: i['code'], reverse=True)[0]['desc'] + + tomorrow_notes = [{'code': int(item['weatherCode']), 'desc': item['weatherDesc'][0]['value'] } + for item in tomorrow_forecast['hourly']] + tomorrow_noteworthy = sorted(tomorrow_notes, key=lambda i: i['code'], reverse=True)[0]['desc'] + + day_after_tomorrow_notes = [{'code': int(item['weatherCode']), 'desc': item['weatherDesc'][0]['value'] } + for item in day_after_tomorrow_forecast['hourly']] + day_after_tomorrow_noteworthy = sorted(day_after_tomorrow_notes, key=lambda i: i['code'], reverse=True)[0]['desc'] + summary = { 'location': query, 'current': { @@ -41,10 +54,32 @@ def weather_summary(query): 'precipitation': f"{current.get('precipMM')} mm", 'visibility': f"{current.get('visibility')} mi", 'wind_speed': f"{current.get('windspeedMiles')} MPH", - 'wind_direction': f"{current.get('winddir16Point')}", + 'wind_direction': current.get('winddir16Point'), 'pressure': f"{current.get('pressure')} mb", - 'uv_index': f"{current.get('uvIndex')}", + 'uv_index': current.get('uvIndex'), + }, + 'today_forecast': { + 'high_C': f"{today_forecast.get('maxtempC')}°C", + 'high_F': f"{today_forecast.get('maxtempF')}°F", + 'low_C': f"{today_forecast.get('mintempC')}°C", + 'low_F': f"{today_forecast.get('mintempF')}°F", + 'noteworthy': today_noteworthy, + }, + 'tomorrow_forecast': { + 'high_C': f"{tomorrow_forecast.get('maxtempC')}°C", + 'high_F': f"{tomorrow_forecast.get('maxtempF')}°F", + 'low_C': f"{tomorrow_forecast.get('mintempC')}°C", + 'low_F': f"{tomorrow_forecast.get('mintempF')}°F", + 'noteworthy': tomorrow_noteworthy, + }, + 'day_after_tomorrow_forecast': { + 'high_C': f"{day_after_tomorrow_forecast.get('maxtempC')}°C", + 'high_F': f"{day_after_tomorrow_forecast.get('maxtempF')}°F", + 'low_C': f"{day_after_tomorrow_forecast.get('mintempC')}°C", + 'low_F': f"{day_after_tomorrow_forecast.get('mintempF')}°F", + 'noteworthy': day_after_tomorrow_noteworthy, }, } + logger.debug(f"results: {summary}") return summary From c0c030641991b4cecb1129abbbcfece940f4e53f Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sun, 6 Oct 2019 09:33:46 -0500 Subject: [PATCH 18/21] expose weather report as an rpc view --- dr_botzo/urls.py | 1 + weather/urls.py | 8 ++++++++ weather/views.py | 23 +++++++++++++++++++++++ 3 files changed, 32 insertions(+) create mode 100644 weather/urls.py create mode 100644 weather/views.py diff --git a/dr_botzo/urls.py b/dr_botzo/urls.py index e0a8a41..3abb52b 100644 --- a/dr_botzo/urls.py +++ b/dr_botzo/urls.py @@ -19,6 +19,7 @@ urlpatterns = [ url(r'^karma/', include('karma.urls')), url(r'^markov/', include('markov.urls')), url(r'^races/', include('races.urls')), + url(r'^weather/', include('weather.urls')), url(r'^accounts/', include('registration.backends.default.urls')), url(r'^admin/', admin.site.urls), diff --git a/weather/urls.py b/weather/urls.py new file mode 100644 index 0000000..26bf7fd --- /dev/null +++ b/weather/urls.py @@ -0,0 +1,8 @@ +"""URL patterns for markov stuff.""" +from django.urls import path + +from weather.views import rpc_weather_report + +urlpatterns = [ + path('rpc//', rpc_weather_report, name='weather_rpc_query'), +] diff --git a/weather/views.py b/weather/views.py new file mode 100644 index 0000000..f9db0dd --- /dev/null +++ b/weather/views.py @@ -0,0 +1,23 @@ +"""Manipulate Markov data via the Django site.""" +import logging + +from rest_framework.authentication import BasicAuthentication +from rest_framework.permissions import IsAuthenticated +from rest_framework.response import Response +from rest_framework.decorators import api_view, authentication_classes, permission_classes + +from weather.lib import weather_summary + +logger = logging.getLogger(__name__) + + +@api_view(['GET']) +@authentication_classes((BasicAuthentication, )) +@permission_classes((IsAuthenticated, )) +def rpc_weather_report(request, query): + """Provide the weather report for a given query.""" + if request.method != 'GET': + return Response({'detail': "Supported method: GET."}, status=405) + + report = weather_summary(query) + return Response(report) From 5f6e255ded17ff3463315ccbe2aa72d28cb2749d Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sun, 6 Oct 2019 09:34:01 -0500 Subject: [PATCH 19/21] fix some line length violations in weather/ircplugin.py --- weather/ircplugin.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/weather/ircplugin.py b/weather/ircplugin.py index 0d88645..8e5d746 100644 --- a/weather/ircplugin.py +++ b/weather/ircplugin.py @@ -36,12 +36,15 @@ class Weather(Plugin): weather = weather_summary(queryitems[0]) weather_output = (f"Weather in {weather['location']}: {weather['current']['description']}. " f"{weather['current']['temp_F']}/{weather['current']['temp_C']}, " - f"feels like {weather['current']['feels_like_temp_F']}/{weather['current']['feels_like_temp_C']}. " - f"Wind {weather['current']['wind_speed']} from the {weather['current']['wind_direction']}. " + f"feels like {weather['current']['feels_like_temp_F']}/" + f"{weather['current']['feels_like_temp_C']}. " + f"Wind {weather['current']['wind_speed']} " + f"from the {weather['current']['wind_direction']}. " f"Visibility {weather['current']['visibility']}. " f"Precipitation {weather['current']['precipitation']}. " f"Pressure {weather['current']['pressure']}. " - f"Cloud cover {weather['current']['cloud_cover']}. UV index {weather['current']['uv_index']}. " + f"Cloud cover {weather['current']['cloud_cover']}. " + f"UV index {weather['current']['uv_index']}. " f"Today: {weather['today_forecast']['noteworthy']}, " f"High {weather['today_forecast']['high_F']}/{weather['today_forecast']['high_C']}, " f"Low {weather['today_forecast']['low_F']}/{weather['today_forecast']['low_C']}. " @@ -49,9 +52,10 @@ class Weather(Plugin): f"High {weather['tomorrow_forecast']['high_F']}/{weather['tomorrow_forecast']['high_C']}, " f"Low {weather['tomorrow_forecast']['low_F']}/{weather['tomorrow_forecast']['low_C']}. " f"Day after tomorrow: {weather['day_after_tomorrow_forecast']['noteworthy']}, " - f"High {weather['day_after_tomorrow_forecast']['high_F']}/{weather['day_after_tomorrow_forecast']['high_C']}, " - f"Low {weather['day_after_tomorrow_forecast']['low_F']}/{weather['day_after_tomorrow_forecast']['low_C']}." - ) + f"High {weather['day_after_tomorrow_forecast']['high_F']}/" + f"{weather['day_after_tomorrow_forecast']['high_C']}, " + f"Low {weather['day_after_tomorrow_forecast']['low_F']}/" + f"{weather['day_after_tomorrow_forecast']['low_C']}.") return self.bot.reply(event, weather_output) From d5e1a2ed45987e6ecf62057a41cc4794b5d601d6 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sun, 6 Oct 2019 10:44:21 -0500 Subject: [PATCH 20/21] actually use an f-string when querying wttr.in --- weather/lib.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/weather/lib.py b/weather/lib.py index 18748bb..6b6611f 100644 --- a/weather/lib.py +++ b/weather/lib.py @@ -8,8 +8,8 @@ logger = logging.getLogger(__name__) def query_wttr_in(query): """Hit the wttr.in JSON API with the provided query.""" - logger.info(f"about to query wttr.in with '{query}") - response = requests.get('http://wttr.in/{query}?format=j1') + logger.info(f"about to query wttr.in with '{query}'") + response = requests.get(f'http://wttr.in/{query}?format=j1') response.raise_for_status() weather_info = response.json() @@ -19,7 +19,7 @@ def query_wttr_in(query): def weather_summary(query): """Create a more consumable version of the weather report.""" - logger.info(f"assembling weather summary for '{query}") + logger.info(f"assembling weather summary for '{query}'") weather_info = query_wttr_in(query) # get some common/nested stuff once now From c670072c868d029b84219fedd13f3afeaa40b86a Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Fri, 11 Oct 2019 08:37:16 -0500 Subject: [PATCH 21/21] add versioneer stuff to the project --- .gitattributes | 1 + .gitignore | 25 +- MANIFEST.in | 2 + dr_botzo/__init__.py | 4 + dr_botzo/_version.py | 520 ++++++++++++ requirements-dev.in | 1 + requirements-dev.txt | 3 +- setup.cfg | 6 + setup.py | 28 + versioneer.py | 1822 ++++++++++++++++++++++++++++++++++++++++++ 10 files changed, 2400 insertions(+), 12 deletions(-) create mode 100644 .gitattributes create mode 100644 MANIFEST.in create mode 100644 dr_botzo/_version.py create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 versioneer.py diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..9c191ee --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +dr_botzo/_version.py export-subst diff --git a/.gitignore b/.gitignore index 1272d46..6e9eb1a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,14 +1,8 @@ -*.facts -*.json -*.log -*.pyc -*.sqlite3 -*.swo -*.swp -*.urls -*~ -.idea -tags +.idea/ +build/ +dist/ +tags/ +*.egg-info/ dr.botzo.data dr.botzo.cfg localsettings.py @@ -18,3 +12,12 @@ parsetab.py megahal.* dr.botzo.log dr.botzo.markov +*.facts +*.json +*.log +*.pyc +*.sqlite3 +*.swo +*.swp +*.urls +*~ diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..eea1252 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include versioneer.py +include dr_botzo/_version.py diff --git a/dr_botzo/__init__.py b/dr_botzo/__init__.py index e69de29..5b54f80 100644 --- a/dr_botzo/__init__.py +++ b/dr_botzo/__init__.py @@ -0,0 +1,4 @@ +"""Set up the version number of the bot.""" +from ._version import get_versions +__version__ = get_versions()['version'] +del get_versions diff --git a/dr_botzo/_version.py b/dr_botzo/_version.py new file mode 100644 index 0000000..6d8307e --- /dev/null +++ b/dr_botzo/_version.py @@ -0,0 +1,520 @@ + +# This file helps to compute a version number in source trees obtained from +# git-archive tarball (such as those provided by githubs download-from-tag +# feature). Distribution tarballs (built by setup.py sdist) and build +# directories (produced by setup.py build) will contain a much shorter file +# that just contains the computed version number. + +# This file is released into the public domain. Generated by +# versioneer-0.18 (https://github.com/warner/python-versioneer) + +"""Git implementation of _version.py.""" + +import errno +import os +import re +import subprocess +import sys + + +def get_keywords(): + """Get the keywords needed to look up the version information.""" + # these strings will be replaced by git during git-archive. + # setup.py/versioneer.py will grep for the variable names, so they must + # each be defined on a line of their own. _version.py will just call + # get_keywords(). + git_refnames = "$Format:%d$" + git_full = "$Format:%H$" + git_date = "$Format:%ci$" + keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} + return keywords + + +class VersioneerConfig: + """Container for Versioneer configuration parameters.""" + + +def get_config(): + """Create, populate and return the VersioneerConfig() object.""" + # these strings are filled in when 'setup.py versioneer' creates + # _version.py + cfg = VersioneerConfig() + cfg.VCS = "git" + cfg.style = "pep440" + cfg.tag_prefix = "v" + cfg.parentdir_prefix = "None" + cfg.versionfile_source = "dr_botzo/_version.py" + cfg.verbose = False + return cfg + + +class NotThisMethod(Exception): + """Exception raised if a method is not valid for the current scenario.""" + + +LONG_VERSION_PY = {} +HANDLERS = {} + + +def register_vcs_handler(vcs, method): # decorator + """Decorator to mark a method as the handler for a particular VCS.""" + def decorate(f): + """Store f in HANDLERS[vcs][method].""" + if vcs not in HANDLERS: + HANDLERS[vcs] = {} + HANDLERS[vcs][method] = f + return f + return decorate + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, + env=None): + """Call the given command(s).""" + assert isinstance(commands, list) + p = None + for c in commands: + try: + dispcmd = str([c] + args) + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %s" % dispcmd) + print(e) + return None, None + else: + if verbose: + print("unable to find command, tried %s" % (commands,)) + return None, None + stdout = p.communicate()[0].strip() + if sys.version_info[0] >= 3: + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %s (error)" % dispcmd) + print("stdout was %s" % stdout) + return None, p.returncode + return stdout, p.returncode + + +def versions_from_parentdir(parentdir_prefix, root, verbose): + """Try to determine the version from the parent directory name. + + Source tarballs conventionally unpack into a directory that includes both + the project name and a version string. We will also support searching up + two directory levels for an appropriately named parent directory + """ + rootdirs = [] + + for i in range(3): + dirname = os.path.basename(root) + if dirname.startswith(parentdir_prefix): + return {"version": dirname[len(parentdir_prefix):], + "full-revisionid": None, + "dirty": False, "error": None, "date": None} + else: + rootdirs.append(root) + root = os.path.dirname(root) # up a level + + if verbose: + print("Tried directories %s but none started with prefix %s" % + (str(rootdirs), parentdir_prefix)) + raise NotThisMethod("rootdir doesn't start with parentdir_prefix") + + +@register_vcs_handler("git", "get_keywords") +def git_get_keywords(versionfile_abs): + """Extract version information from the given file.""" + # the code embedded in _version.py can just fetch the value of these + # keywords. When used from setup.py, we don't want to import _version.py, + # so we do it with a regexp instead. This function is not used from + # _version.py. + keywords = {} + try: + f = open(versionfile_abs, "r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return keywords + + +@register_vcs_handler("git", "keywords") +def git_versions_from_keywords(keywords, tag_prefix, verbose): + """Get version information from git keywords.""" + if not keywords: + raise NotThisMethod("no keywords at all, weird") + date = keywords.get("date") + if date is not None: + # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant + # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 + # -like" string, which we must then edit to make compliant), because + # it's been around since git-1.5.3, and it's too difficult to + # discover which version we're using, or to work around using an + # older one. + date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + refnames = keywords["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("keywords are unexpanded, not using") + raise NotThisMethod("unexpanded keywords, not a git-archive tarball") + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of + # just "foo-1.0". If we see a "tag: " prefix, prefer those. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # Either we're using git < 1.8.3, or there really are no tags. We use + # a heuristic: assume all version tags have a digit. The old git %d + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%s', no digits" % ",".join(refs - tags)) + if verbose: + print("likely tags: %s" % ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %s" % r) + return {"version": r, + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": None, + "date": date} + # no suitable tags, so version is "0+unknown", but full hex is still there + if verbose: + print("no suitable tags, using unknown + full revision id") + return {"version": "0+unknown", + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": "no suitable tags", "date": None} + + +@register_vcs_handler("git", "pieces_from_vcs") +def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): + """Get version from 'git describe' in the root of the source tree. + + This only gets called if the git-archive 'subst' keywords were *not* + expanded, and _version.py hasn't already been rewritten with a short + version string, meaning we're inside a checked out source tree. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + + out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) + if rc != 0: + if verbose: + print("Directory %s not under git control" % root) + raise NotThisMethod("'git rev-parse --git-dir' returned error") + + # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] + # if there isn't one, this yields HEX[-dirty] (no NUM) + describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", "%s*" % tag_prefix], + cwd=root) + # --long was added in git-1.5.5 + if describe_out is None: + raise NotThisMethod("'git describe' failed") + describe_out = describe_out.strip() + full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if full_out is None: + raise NotThisMethod("'git rev-parse' failed") + full_out = full_out.strip() + + pieces = {} + pieces["long"] = full_out + pieces["short"] = full_out[:7] # maybe improved later + pieces["error"] = None + + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] + # TAG might have hyphens. + git_describe = describe_out + + # look for -dirty suffix + dirty = git_describe.endswith("-dirty") + pieces["dirty"] = dirty + if dirty: + git_describe = git_describe[:git_describe.rindex("-dirty")] + + # now we have TAG-NUM-gHEX or HEX + + if "-" in git_describe: + # TAG-NUM-gHEX + mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) + if not mo: + # unparseable. Maybe git-describe is misbehaving? + pieces["error"] = ("unable to parse git-describe output: '%s'" + % describe_out) + return pieces + + # tag + full_tag = mo.group(1) + if not full_tag.startswith(tag_prefix): + if verbose: + fmt = "tag '%s' doesn't start with prefix '%s'" + print(fmt % (full_tag, tag_prefix)) + pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" + % (full_tag, tag_prefix)) + return pieces + pieces["closest-tag"] = full_tag[len(tag_prefix):] + + # distance: number of commits since tag + pieces["distance"] = int(mo.group(2)) + + # commit: short hex revision ID + pieces["short"] = mo.group(3) + + else: + # HEX: no tags + pieces["closest-tag"] = None + count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], + cwd=root) + pieces["distance"] = int(count_out) # total number of commits + + # commit date: see ISO-8601 comment in git_versions_from_keywords() + date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], + cwd=root)[0].strip() + pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + + return pieces + + +def plus_or_dot(pieces): + """Return a + if we don't already have one, else return a .""" + if "+" in pieces.get("closest-tag", ""): + return "." + return "+" + + +def render_pep440(pieces): + """Build up version string, with post-release "local version identifier". + + Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you + get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty + + Exceptions: + 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += plus_or_dot(pieces) + rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0+untagged.%d.g%s" % (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_pre(pieces): + """TAG[.post.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post.devDISTANCE + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += ".post.dev%d" % pieces["distance"] + else: + # exception #1 + rendered = "0.post.dev%d" % pieces["distance"] + return rendered + + +def render_pep440_post(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX] . + + The ".dev0" means dirty. Note that .dev0 sorts backwards + (a dirty tree will appear "older" than the corresponding clean one), + but you shouldn't be releasing software with -dirty anyways. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%s" % pieces["short"] + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += "+g%s" % pieces["short"] + return rendered + + +def render_pep440_old(pieces): + """TAG[.postDISTANCE[.dev0]] . + + The ".dev0" means dirty. + + Eexceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + return rendered + + +def render_git_describe(pieces): + """TAG[-DISTANCE-gHEX][-dirty]. + + Like 'git describe --tags --dirty --always'. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render_git_describe_long(pieces): + """TAG-DISTANCE-gHEX[-dirty]. + + Like 'git describe --tags --dirty --always -long'. + The distance/hash is unconditional. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render(pieces, style): + """Render the given version pieces into the requested style.""" + if pieces["error"]: + return {"version": "unknown", + "full-revisionid": pieces.get("long"), + "dirty": None, + "error": pieces["error"], + "date": None} + + if not style or style == "default": + style = "pep440" # the default + + if style == "pep440": + rendered = render_pep440(pieces) + elif style == "pep440-pre": + rendered = render_pep440_pre(pieces) + elif style == "pep440-post": + rendered = render_pep440_post(pieces) + elif style == "pep440-old": + rendered = render_pep440_old(pieces) + elif style == "git-describe": + rendered = render_git_describe(pieces) + elif style == "git-describe-long": + rendered = render_git_describe_long(pieces) + else: + raise ValueError("unknown style '%s'" % style) + + return {"version": rendered, "full-revisionid": pieces["long"], + "dirty": pieces["dirty"], "error": None, + "date": pieces.get("date")} + + +def get_versions(): + """Get version information or return default if unable to do so.""" + # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have + # __file__, we can work backwards from there to the root. Some + # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which + # case we can only use expanded keywords. + + cfg = get_config() + verbose = cfg.verbose + + try: + return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, + verbose) + except NotThisMethod: + pass + + try: + root = os.path.realpath(__file__) + # versionfile_source is the relative path from the top of the source + # tree (where the .git directory might live) to this file. Invert + # this to find the root from __file__. + for i in cfg.versionfile_source.split('/'): + root = os.path.dirname(root) + except NameError: + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to find root of source tree", + "date": None} + + try: + pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) + return render(pieces, cfg.style) + except NotThisMethod: + pass + + try: + if cfg.parentdir_prefix: + return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) + except NotThisMethod: + pass + + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to compute version", "date": None} diff --git a/requirements-dev.in b/requirements-dev.in index 9634d69..8b474bf 100644 --- a/requirements-dev.in +++ b/requirements-dev.in @@ -3,3 +3,4 @@ logilab-common # prospector thing, i guess pip-tools # pip-compile prospector # code quality +versioneer # auto-generate version numbers diff --git a/requirements-dev.txt b/requirements-dev.txt index ae2333c..4e73415 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -61,7 +61,8 @@ tempora==1.14.1 # via irc, jaraco.logging twython==3.7.0 typed-ast==1.4.0 # via astroid urllib3==1.25.3 # via requests +versioneer==0.18 wrapt==1.11.2 # via astroid # The following packages are considered to be unsafe in a requirements file: -# setuptools==41.2.0 # via logilab-common +# setuptools==41.4.0 # via logilab-common diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..3fb635a --- /dev/null +++ b/setup.cfg @@ -0,0 +1,6 @@ +[versioneer] +VCS = git +style = pep440 +versionfile_source = dr_botzo/_version.py +versionfile_build = dr_botzo/_version.py +tag_prefix = v diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..41d7d2b --- /dev/null +++ b/setup.py @@ -0,0 +1,28 @@ +"""Setuptools configuration.""" +import os +from setuptools import find_packages, setup + +import versioneer + +HERE = os.path.dirname(os.path.abspath(__file__)) + + +def extract_requires(): + with open(os.path.join(HERE, 'requirements.in'), 'r') as reqs: + return [line.split(' ')[0] for line in reqs if not line[0] == '-'] + + +setup( + name="dr.botzo", + description="A Django-backed IRC bot that also provides a WS framework for other bots to call.", + url="https://git.incorporeal.org/bss/dr.botzo", + license='GPLv3', + author="Brian S. Stephan", + author_email="bss@incorporeal.org", + version=versioneer.get_version(), + cmdclass=versioneer.get_cmdclass(), + packages=find_packages(), + include_package_data=True, + zip_safe=False, + install_requires=extract_requires(), +) diff --git a/versioneer.py b/versioneer.py new file mode 100644 index 0000000..64fea1c --- /dev/null +++ b/versioneer.py @@ -0,0 +1,1822 @@ + +# Version: 0.18 + +"""The Versioneer - like a rocketeer, but for versions. + +The Versioneer +============== + +* like a rocketeer, but for versions! +* https://github.com/warner/python-versioneer +* Brian Warner +* License: Public Domain +* Compatible With: python2.6, 2.7, 3.2, 3.3, 3.4, 3.5, 3.6, and pypy +* [![Latest Version] +(https://pypip.in/version/versioneer/badge.svg?style=flat) +](https://pypi.python.org/pypi/versioneer/) +* [![Build Status] +(https://travis-ci.org/warner/python-versioneer.png?branch=master) +](https://travis-ci.org/warner/python-versioneer) + +This is a tool for managing a recorded version number in distutils-based +python projects. The goal is to remove the tedious and error-prone "update +the embedded version string" step from your release process. Making a new +release should be as easy as recording a new tag in your version-control +system, and maybe making new tarballs. + + +## Quick Install + +* `pip install versioneer` to somewhere to your $PATH +* add a `[versioneer]` section to your setup.cfg (see below) +* run `versioneer install` in your source tree, commit the results + +## Version Identifiers + +Source trees come from a variety of places: + +* a version-control system checkout (mostly used by developers) +* a nightly tarball, produced by build automation +* a snapshot tarball, produced by a web-based VCS browser, like github's + "tarball from tag" feature +* a release tarball, produced by "setup.py sdist", distributed through PyPI + +Within each source tree, the version identifier (either a string or a number, +this tool is format-agnostic) can come from a variety of places: + +* ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows + about recent "tags" and an absolute revision-id +* the name of the directory into which the tarball was unpacked +* an expanded VCS keyword ($Id$, etc) +* a `_version.py` created by some earlier build step + +For released software, the version identifier is closely related to a VCS +tag. Some projects use tag names that include more than just the version +string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool +needs to strip the tag prefix to extract the version identifier. For +unreleased software (between tags), the version identifier should provide +enough information to help developers recreate the same tree, while also +giving them an idea of roughly how old the tree is (after version 1.2, before +version 1.3). Many VCS systems can report a description that captures this, +for example `git describe --tags --dirty --always` reports things like +"0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the +0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has +uncommitted changes. + +The version identifier is used for multiple purposes: + +* to allow the module to self-identify its version: `myproject.__version__` +* to choose a name and prefix for a 'setup.py sdist' tarball + +## Theory of Operation + +Versioneer works by adding a special `_version.py` file into your source +tree, where your `__init__.py` can import it. This `_version.py` knows how to +dynamically ask the VCS tool for version information at import time. + +`_version.py` also contains `$Revision$` markers, and the installation +process marks `_version.py` to have this marker rewritten with a tag name +during the `git archive` command. As a result, generated tarballs will +contain enough information to get the proper version. + +To allow `setup.py` to compute a version too, a `versioneer.py` is added to +the top level of your source tree, next to `setup.py` and the `setup.cfg` +that configures it. This overrides several distutils/setuptools commands to +compute the version when invoked, and changes `setup.py build` and `setup.py +sdist` to replace `_version.py` with a small static file that contains just +the generated version data. + +## Installation + +See [INSTALL.md](./INSTALL.md) for detailed installation instructions. + +## Version-String Flavors + +Code which uses Versioneer can learn about its version string at runtime by +importing `_version` from your main `__init__.py` file and running the +`get_versions()` function. From the "outside" (e.g. in `setup.py`), you can +import the top-level `versioneer.py` and run `get_versions()`. + +Both functions return a dictionary with different flavors of version +information: + +* `['version']`: A condensed version string, rendered using the selected + style. This is the most commonly used value for the project's version + string. The default "pep440" style yields strings like `0.11`, + `0.11+2.g1076c97`, or `0.11+2.g1076c97.dirty`. See the "Styles" section + below for alternative styles. + +* `['full-revisionid']`: detailed revision identifier. For Git, this is the + full SHA1 commit id, e.g. "1076c978a8d3cfc70f408fe5974aa6c092c949ac". + +* `['date']`: Date and time of the latest `HEAD` commit. For Git, it is the + commit date in ISO 8601 format. This will be None if the date is not + available. + +* `['dirty']`: a boolean, True if the tree has uncommitted changes. Note that + this is only accurate if run in a VCS checkout, otherwise it is likely to + be False or None + +* `['error']`: if the version string could not be computed, this will be set + to a string describing the problem, otherwise it will be None. It may be + useful to throw an exception in setup.py if this is set, to avoid e.g. + creating tarballs with a version string of "unknown". + +Some variants are more useful than others. Including `full-revisionid` in a +bug report should allow developers to reconstruct the exact code being tested +(or indicate the presence of local changes that should be shared with the +developers). `version` is suitable for display in an "about" box or a CLI +`--version` output: it can be easily compared against release notes and lists +of bugs fixed in various releases. + +The installer adds the following text to your `__init__.py` to place a basic +version in `YOURPROJECT.__version__`: + + from ._version import get_versions + __version__ = get_versions()['version'] + del get_versions + +## Styles + +The setup.cfg `style=` configuration controls how the VCS information is +rendered into a version string. + +The default style, "pep440", produces a PEP440-compliant string, equal to the +un-prefixed tag name for actual releases, and containing an additional "local +version" section with more detail for in-between builds. For Git, this is +TAG[+DISTANCE.gHEX[.dirty]] , using information from `git describe --tags +--dirty --always`. For example "0.11+2.g1076c97.dirty" indicates that the +tree is like the "1076c97" commit but has uncommitted changes (".dirty"), and +that this commit is two revisions ("+2") beyond the "0.11" tag. For released +software (exactly equal to a known tag), the identifier will only contain the +stripped tag, e.g. "0.11". + +Other styles are available. See [details.md](details.md) in the Versioneer +source tree for descriptions. + +## Debugging + +Versioneer tries to avoid fatal errors: if something goes wrong, it will tend +to return a version of "0+unknown". To investigate the problem, run `setup.py +version`, which will run the version-lookup code in a verbose mode, and will +display the full contents of `get_versions()` (including the `error` string, +which may help identify what went wrong). + +## Known Limitations + +Some situations are known to cause problems for Versioneer. This details the +most significant ones. More can be found on Github +[issues page](https://github.com/warner/python-versioneer/issues). + +### Subprojects + +Versioneer has limited support for source trees in which `setup.py` is not in +the root directory (e.g. `setup.py` and `.git/` are *not* siblings). The are +two common reasons why `setup.py` might not be in the root: + +* Source trees which contain multiple subprojects, such as + [Buildbot](https://github.com/buildbot/buildbot), which contains both + "master" and "slave" subprojects, each with their own `setup.py`, + `setup.cfg`, and `tox.ini`. Projects like these produce multiple PyPI + distributions (and upload multiple independently-installable tarballs). +* Source trees whose main purpose is to contain a C library, but which also + provide bindings to Python (and perhaps other langauges) in subdirectories. + +Versioneer will look for `.git` in parent directories, and most operations +should get the right version string. However `pip` and `setuptools` have bugs +and implementation details which frequently cause `pip install .` from a +subproject directory to fail to find a correct version string (so it usually +defaults to `0+unknown`). + +`pip install --editable .` should work correctly. `setup.py install` might +work too. + +Pip-8.1.1 is known to have this problem, but hopefully it will get fixed in +some later version. + +[Bug #38](https://github.com/warner/python-versioneer/issues/38) is tracking +this issue. The discussion in +[PR #61](https://github.com/warner/python-versioneer/pull/61) describes the +issue from the Versioneer side in more detail. +[pip PR#3176](https://github.com/pypa/pip/pull/3176) and +[pip PR#3615](https://github.com/pypa/pip/pull/3615) contain work to improve +pip to let Versioneer work correctly. + +Versioneer-0.16 and earlier only looked for a `.git` directory next to the +`setup.cfg`, so subprojects were completely unsupported with those releases. + +### Editable installs with setuptools <= 18.5 + +`setup.py develop` and `pip install --editable .` allow you to install a +project into a virtualenv once, then continue editing the source code (and +test) without re-installing after every change. + +"Entry-point scripts" (`setup(entry_points={"console_scripts": ..})`) are a +convenient way to specify executable scripts that should be installed along +with the python package. + +These both work as expected when using modern setuptools. When using +setuptools-18.5 or earlier, however, certain operations will cause +`pkg_resources.DistributionNotFound` errors when running the entrypoint +script, which must be resolved by re-installing the package. This happens +when the install happens with one version, then the egg_info data is +regenerated while a different version is checked out. Many setup.py commands +cause egg_info to be rebuilt (including `sdist`, `wheel`, and installing into +a different virtualenv), so this can be surprising. + +[Bug #83](https://github.com/warner/python-versioneer/issues/83) describes +this one, but upgrading to a newer version of setuptools should probably +resolve it. + +### Unicode version strings + +While Versioneer works (and is continually tested) with both Python 2 and +Python 3, it is not entirely consistent with bytes-vs-unicode distinctions. +Newer releases probably generate unicode version strings on py2. It's not +clear that this is wrong, but it may be surprising for applications when then +write these strings to a network connection or include them in bytes-oriented +APIs like cryptographic checksums. + +[Bug #71](https://github.com/warner/python-versioneer/issues/71) investigates +this question. + + +## Updating Versioneer + +To upgrade your project to a new release of Versioneer, do the following: + +* install the new Versioneer (`pip install -U versioneer` or equivalent) +* edit `setup.cfg`, if necessary, to include any new configuration settings + indicated by the release notes. See [UPGRADING](./UPGRADING.md) for details. +* re-run `versioneer install` in your source tree, to replace + `SRC/_version.py` +* commit any changed files + +## Future Directions + +This tool is designed to make it easily extended to other version-control +systems: all VCS-specific components are in separate directories like +src/git/ . The top-level `versioneer.py` script is assembled from these +components by running make-versioneer.py . In the future, make-versioneer.py +will take a VCS name as an argument, and will construct a version of +`versioneer.py` that is specific to the given VCS. It might also take the +configuration arguments that are currently provided manually during +installation by editing setup.py . Alternatively, it might go the other +direction and include code from all supported VCS systems, reducing the +number of intermediate scripts. + + +## License + +To make Versioneer easier to embed, all its code is dedicated to the public +domain. The `_version.py` that it creates is also in the public domain. +Specifically, both are released under the Creative Commons "Public Domain +Dedication" license (CC0-1.0), as described in +https://creativecommons.org/publicdomain/zero/1.0/ . + +""" + +from __future__ import print_function +try: + import configparser +except ImportError: + import ConfigParser as configparser +import errno +import json +import os +import re +import subprocess +import sys + + +class VersioneerConfig: + """Container for Versioneer configuration parameters.""" + + +def get_root(): + """Get the project root directory. + + We require that all commands are run from the project root, i.e. the + directory that contains setup.py, setup.cfg, and versioneer.py . + """ + root = os.path.realpath(os.path.abspath(os.getcwd())) + setup_py = os.path.join(root, "setup.py") + versioneer_py = os.path.join(root, "versioneer.py") + if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): + # allow 'python path/to/setup.py COMMAND' + root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0]))) + setup_py = os.path.join(root, "setup.py") + versioneer_py = os.path.join(root, "versioneer.py") + if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): + err = ("Versioneer was unable to run the project root directory. " + "Versioneer requires setup.py to be executed from " + "its immediate directory (like 'python setup.py COMMAND'), " + "or in a way that lets it use sys.argv[0] to find the root " + "(like 'python path/to/setup.py COMMAND').") + raise VersioneerBadRootError(err) + try: + # Certain runtime workflows (setup.py install/develop in a setuptools + # tree) execute all dependencies in a single python process, so + # "versioneer" may be imported multiple times, and python's shared + # module-import table will cache the first one. So we can't use + # os.path.dirname(__file__), as that will find whichever + # versioneer.py was first imported, even in later projects. + me = os.path.realpath(os.path.abspath(__file__)) + me_dir = os.path.normcase(os.path.splitext(me)[0]) + vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0]) + if me_dir != vsr_dir: + print("Warning: build in %s is using versioneer.py from %s" + % (os.path.dirname(me), versioneer_py)) + except NameError: + pass + return root + + +def get_config_from_root(root): + """Read the project setup.cfg file to determine Versioneer config.""" + # This might raise EnvironmentError (if setup.cfg is missing), or + # configparser.NoSectionError (if it lacks a [versioneer] section), or + # configparser.NoOptionError (if it lacks "VCS="). See the docstring at + # the top of versioneer.py for instructions on writing your setup.cfg . + setup_cfg = os.path.join(root, "setup.cfg") + parser = configparser.SafeConfigParser() + with open(setup_cfg, "r") as f: + parser.readfp(f) + VCS = parser.get("versioneer", "VCS") # mandatory + + def get(parser, name): + if parser.has_option("versioneer", name): + return parser.get("versioneer", name) + return None + cfg = VersioneerConfig() + cfg.VCS = VCS + cfg.style = get(parser, "style") or "" + cfg.versionfile_source = get(parser, "versionfile_source") + cfg.versionfile_build = get(parser, "versionfile_build") + cfg.tag_prefix = get(parser, "tag_prefix") + if cfg.tag_prefix in ("''", '""'): + cfg.tag_prefix = "" + cfg.parentdir_prefix = get(parser, "parentdir_prefix") + cfg.verbose = get(parser, "verbose") + return cfg + + +class NotThisMethod(Exception): + """Exception raised if a method is not valid for the current scenario.""" + + +# these dictionaries contain VCS-specific tools +LONG_VERSION_PY = {} +HANDLERS = {} + + +def register_vcs_handler(vcs, method): # decorator + """Decorator to mark a method as the handler for a particular VCS.""" + def decorate(f): + """Store f in HANDLERS[vcs][method].""" + if vcs not in HANDLERS: + HANDLERS[vcs] = {} + HANDLERS[vcs][method] = f + return f + return decorate + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, + env=None): + """Call the given command(s).""" + assert isinstance(commands, list) + p = None + for c in commands: + try: + dispcmd = str([c] + args) + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %s" % dispcmd) + print(e) + return None, None + else: + if verbose: + print("unable to find command, tried %s" % (commands,)) + return None, None + stdout = p.communicate()[0].strip() + if sys.version_info[0] >= 3: + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %s (error)" % dispcmd) + print("stdout was %s" % stdout) + return None, p.returncode + return stdout, p.returncode + + +LONG_VERSION_PY['git'] = ''' +# This file helps to compute a version number in source trees obtained from +# git-archive tarball (such as those provided by githubs download-from-tag +# feature). Distribution tarballs (built by setup.py sdist) and build +# directories (produced by setup.py build) will contain a much shorter file +# that just contains the computed version number. + +# This file is released into the public domain. Generated by +# versioneer-0.18 (https://github.com/warner/python-versioneer) + +"""Git implementation of _version.py.""" + +import errno +import os +import re +import subprocess +import sys + + +def get_keywords(): + """Get the keywords needed to look up the version information.""" + # these strings will be replaced by git during git-archive. + # setup.py/versioneer.py will grep for the variable names, so they must + # each be defined on a line of their own. _version.py will just call + # get_keywords(). + git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" + git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" + git_date = "%(DOLLAR)sFormat:%%ci%(DOLLAR)s" + keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} + return keywords + + +class VersioneerConfig: + """Container for Versioneer configuration parameters.""" + + +def get_config(): + """Create, populate and return the VersioneerConfig() object.""" + # these strings are filled in when 'setup.py versioneer' creates + # _version.py + cfg = VersioneerConfig() + cfg.VCS = "git" + cfg.style = "%(STYLE)s" + cfg.tag_prefix = "%(TAG_PREFIX)s" + cfg.parentdir_prefix = "%(PARENTDIR_PREFIX)s" + cfg.versionfile_source = "%(VERSIONFILE_SOURCE)s" + cfg.verbose = False + return cfg + + +class NotThisMethod(Exception): + """Exception raised if a method is not valid for the current scenario.""" + + +LONG_VERSION_PY = {} +HANDLERS = {} + + +def register_vcs_handler(vcs, method): # decorator + """Decorator to mark a method as the handler for a particular VCS.""" + def decorate(f): + """Store f in HANDLERS[vcs][method].""" + if vcs not in HANDLERS: + HANDLERS[vcs] = {} + HANDLERS[vcs][method] = f + return f + return decorate + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, + env=None): + """Call the given command(s).""" + assert isinstance(commands, list) + p = None + for c in commands: + try: + dispcmd = str([c] + args) + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %%s" %% dispcmd) + print(e) + return None, None + else: + if verbose: + print("unable to find command, tried %%s" %% (commands,)) + return None, None + stdout = p.communicate()[0].strip() + if sys.version_info[0] >= 3: + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %%s (error)" %% dispcmd) + print("stdout was %%s" %% stdout) + return None, p.returncode + return stdout, p.returncode + + +def versions_from_parentdir(parentdir_prefix, root, verbose): + """Try to determine the version from the parent directory name. + + Source tarballs conventionally unpack into a directory that includes both + the project name and a version string. We will also support searching up + two directory levels for an appropriately named parent directory + """ + rootdirs = [] + + for i in range(3): + dirname = os.path.basename(root) + if dirname.startswith(parentdir_prefix): + return {"version": dirname[len(parentdir_prefix):], + "full-revisionid": None, + "dirty": False, "error": None, "date": None} + else: + rootdirs.append(root) + root = os.path.dirname(root) # up a level + + if verbose: + print("Tried directories %%s but none started with prefix %%s" %% + (str(rootdirs), parentdir_prefix)) + raise NotThisMethod("rootdir doesn't start with parentdir_prefix") + + +@register_vcs_handler("git", "get_keywords") +def git_get_keywords(versionfile_abs): + """Extract version information from the given file.""" + # the code embedded in _version.py can just fetch the value of these + # keywords. When used from setup.py, we don't want to import _version.py, + # so we do it with a regexp instead. This function is not used from + # _version.py. + keywords = {} + try: + f = open(versionfile_abs, "r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return keywords + + +@register_vcs_handler("git", "keywords") +def git_versions_from_keywords(keywords, tag_prefix, verbose): + """Get version information from git keywords.""" + if not keywords: + raise NotThisMethod("no keywords at all, weird") + date = keywords.get("date") + if date is not None: + # git-2.2.0 added "%%cI", which expands to an ISO-8601 -compliant + # datestamp. However we prefer "%%ci" (which expands to an "ISO-8601 + # -like" string, which we must then edit to make compliant), because + # it's been around since git-1.5.3, and it's too difficult to + # discover which version we're using, or to work around using an + # older one. + date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + refnames = keywords["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("keywords are unexpanded, not using") + raise NotThisMethod("unexpanded keywords, not a git-archive tarball") + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of + # just "foo-1.0". If we see a "tag: " prefix, prefer those. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # Either we're using git < 1.8.3, or there really are no tags. We use + # a heuristic: assume all version tags have a digit. The old git %%d + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%%s', no digits" %% ",".join(refs - tags)) + if verbose: + print("likely tags: %%s" %% ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %%s" %% r) + return {"version": r, + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": None, + "date": date} + # no suitable tags, so version is "0+unknown", but full hex is still there + if verbose: + print("no suitable tags, using unknown + full revision id") + return {"version": "0+unknown", + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": "no suitable tags", "date": None} + + +@register_vcs_handler("git", "pieces_from_vcs") +def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): + """Get version from 'git describe' in the root of the source tree. + + This only gets called if the git-archive 'subst' keywords were *not* + expanded, and _version.py hasn't already been rewritten with a short + version string, meaning we're inside a checked out source tree. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + + out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) + if rc != 0: + if verbose: + print("Directory %%s not under git control" %% root) + raise NotThisMethod("'git rev-parse --git-dir' returned error") + + # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] + # if there isn't one, this yields HEX[-dirty] (no NUM) + describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", "%%s*" %% tag_prefix], + cwd=root) + # --long was added in git-1.5.5 + if describe_out is None: + raise NotThisMethod("'git describe' failed") + describe_out = describe_out.strip() + full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if full_out is None: + raise NotThisMethod("'git rev-parse' failed") + full_out = full_out.strip() + + pieces = {} + pieces["long"] = full_out + pieces["short"] = full_out[:7] # maybe improved later + pieces["error"] = None + + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] + # TAG might have hyphens. + git_describe = describe_out + + # look for -dirty suffix + dirty = git_describe.endswith("-dirty") + pieces["dirty"] = dirty + if dirty: + git_describe = git_describe[:git_describe.rindex("-dirty")] + + # now we have TAG-NUM-gHEX or HEX + + if "-" in git_describe: + # TAG-NUM-gHEX + mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) + if not mo: + # unparseable. Maybe git-describe is misbehaving? + pieces["error"] = ("unable to parse git-describe output: '%%s'" + %% describe_out) + return pieces + + # tag + full_tag = mo.group(1) + if not full_tag.startswith(tag_prefix): + if verbose: + fmt = "tag '%%s' doesn't start with prefix '%%s'" + print(fmt %% (full_tag, tag_prefix)) + pieces["error"] = ("tag '%%s' doesn't start with prefix '%%s'" + %% (full_tag, tag_prefix)) + return pieces + pieces["closest-tag"] = full_tag[len(tag_prefix):] + + # distance: number of commits since tag + pieces["distance"] = int(mo.group(2)) + + # commit: short hex revision ID + pieces["short"] = mo.group(3) + + else: + # HEX: no tags + pieces["closest-tag"] = None + count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], + cwd=root) + pieces["distance"] = int(count_out) # total number of commits + + # commit date: see ISO-8601 comment in git_versions_from_keywords() + date = run_command(GITS, ["show", "-s", "--format=%%ci", "HEAD"], + cwd=root)[0].strip() + pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + + return pieces + + +def plus_or_dot(pieces): + """Return a + if we don't already have one, else return a .""" + if "+" in pieces.get("closest-tag", ""): + return "." + return "+" + + +def render_pep440(pieces): + """Build up version string, with post-release "local version identifier". + + Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you + get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty + + Exceptions: + 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += plus_or_dot(pieces) + rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0+untagged.%%d.g%%s" %% (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_pre(pieces): + """TAG[.post.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post.devDISTANCE + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += ".post.dev%%d" %% pieces["distance"] + else: + # exception #1 + rendered = "0.post.dev%%d" %% pieces["distance"] + return rendered + + +def render_pep440_post(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX] . + + The ".dev0" means dirty. Note that .dev0 sorts backwards + (a dirty tree will appear "older" than the corresponding clean one), + but you shouldn't be releasing software with -dirty anyways. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%%s" %% pieces["short"] + else: + # exception #1 + rendered = "0.post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += "+g%%s" %% pieces["short"] + return rendered + + +def render_pep440_old(pieces): + """TAG[.postDISTANCE[.dev0]] . + + The ".dev0" means dirty. + + Eexceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + else: + # exception #1 + rendered = "0.post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + return rendered + + +def render_git_describe(pieces): + """TAG[-DISTANCE-gHEX][-dirty]. + + Like 'git describe --tags --dirty --always'. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render_git_describe_long(pieces): + """TAG-DISTANCE-gHEX[-dirty]. + + Like 'git describe --tags --dirty --always -long'. + The distance/hash is unconditional. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render(pieces, style): + """Render the given version pieces into the requested style.""" + if pieces["error"]: + return {"version": "unknown", + "full-revisionid": pieces.get("long"), + "dirty": None, + "error": pieces["error"], + "date": None} + + if not style or style == "default": + style = "pep440" # the default + + if style == "pep440": + rendered = render_pep440(pieces) + elif style == "pep440-pre": + rendered = render_pep440_pre(pieces) + elif style == "pep440-post": + rendered = render_pep440_post(pieces) + elif style == "pep440-old": + rendered = render_pep440_old(pieces) + elif style == "git-describe": + rendered = render_git_describe(pieces) + elif style == "git-describe-long": + rendered = render_git_describe_long(pieces) + else: + raise ValueError("unknown style '%%s'" %% style) + + return {"version": rendered, "full-revisionid": pieces["long"], + "dirty": pieces["dirty"], "error": None, + "date": pieces.get("date")} + + +def get_versions(): + """Get version information or return default if unable to do so.""" + # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have + # __file__, we can work backwards from there to the root. Some + # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which + # case we can only use expanded keywords. + + cfg = get_config() + verbose = cfg.verbose + + try: + return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, + verbose) + except NotThisMethod: + pass + + try: + root = os.path.realpath(__file__) + # versionfile_source is the relative path from the top of the source + # tree (where the .git directory might live) to this file. Invert + # this to find the root from __file__. + for i in cfg.versionfile_source.split('/'): + root = os.path.dirname(root) + except NameError: + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to find root of source tree", + "date": None} + + try: + pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) + return render(pieces, cfg.style) + except NotThisMethod: + pass + + try: + if cfg.parentdir_prefix: + return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) + except NotThisMethod: + pass + + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to compute version", "date": None} +''' + + +@register_vcs_handler("git", "get_keywords") +def git_get_keywords(versionfile_abs): + """Extract version information from the given file.""" + # the code embedded in _version.py can just fetch the value of these + # keywords. When used from setup.py, we don't want to import _version.py, + # so we do it with a regexp instead. This function is not used from + # _version.py. + keywords = {} + try: + f = open(versionfile_abs, "r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return keywords + + +@register_vcs_handler("git", "keywords") +def git_versions_from_keywords(keywords, tag_prefix, verbose): + """Get version information from git keywords.""" + if not keywords: + raise NotThisMethod("no keywords at all, weird") + date = keywords.get("date") + if date is not None: + # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant + # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 + # -like" string, which we must then edit to make compliant), because + # it's been around since git-1.5.3, and it's too difficult to + # discover which version we're using, or to work around using an + # older one. + date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + refnames = keywords["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("keywords are unexpanded, not using") + raise NotThisMethod("unexpanded keywords, not a git-archive tarball") + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of + # just "foo-1.0". If we see a "tag: " prefix, prefer those. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # Either we're using git < 1.8.3, or there really are no tags. We use + # a heuristic: assume all version tags have a digit. The old git %d + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%s', no digits" % ",".join(refs - tags)) + if verbose: + print("likely tags: %s" % ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %s" % r) + return {"version": r, + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": None, + "date": date} + # no suitable tags, so version is "0+unknown", but full hex is still there + if verbose: + print("no suitable tags, using unknown + full revision id") + return {"version": "0+unknown", + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": "no suitable tags", "date": None} + + +@register_vcs_handler("git", "pieces_from_vcs") +def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): + """Get version from 'git describe' in the root of the source tree. + + This only gets called if the git-archive 'subst' keywords were *not* + expanded, and _version.py hasn't already been rewritten with a short + version string, meaning we're inside a checked out source tree. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + + out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) + if rc != 0: + if verbose: + print("Directory %s not under git control" % root) + raise NotThisMethod("'git rev-parse --git-dir' returned error") + + # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] + # if there isn't one, this yields HEX[-dirty] (no NUM) + describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", "%s*" % tag_prefix], + cwd=root) + # --long was added in git-1.5.5 + if describe_out is None: + raise NotThisMethod("'git describe' failed") + describe_out = describe_out.strip() + full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if full_out is None: + raise NotThisMethod("'git rev-parse' failed") + full_out = full_out.strip() + + pieces = {} + pieces["long"] = full_out + pieces["short"] = full_out[:7] # maybe improved later + pieces["error"] = None + + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] + # TAG might have hyphens. + git_describe = describe_out + + # look for -dirty suffix + dirty = git_describe.endswith("-dirty") + pieces["dirty"] = dirty + if dirty: + git_describe = git_describe[:git_describe.rindex("-dirty")] + + # now we have TAG-NUM-gHEX or HEX + + if "-" in git_describe: + # TAG-NUM-gHEX + mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) + if not mo: + # unparseable. Maybe git-describe is misbehaving? + pieces["error"] = ("unable to parse git-describe output: '%s'" + % describe_out) + return pieces + + # tag + full_tag = mo.group(1) + if not full_tag.startswith(tag_prefix): + if verbose: + fmt = "tag '%s' doesn't start with prefix '%s'" + print(fmt % (full_tag, tag_prefix)) + pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" + % (full_tag, tag_prefix)) + return pieces + pieces["closest-tag"] = full_tag[len(tag_prefix):] + + # distance: number of commits since tag + pieces["distance"] = int(mo.group(2)) + + # commit: short hex revision ID + pieces["short"] = mo.group(3) + + else: + # HEX: no tags + pieces["closest-tag"] = None + count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], + cwd=root) + pieces["distance"] = int(count_out) # total number of commits + + # commit date: see ISO-8601 comment in git_versions_from_keywords() + date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], + cwd=root)[0].strip() + pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + + return pieces + + +def do_vcs_install(manifest_in, versionfile_source, ipy): + """Git-specific installation logic for Versioneer. + + For Git, this means creating/changing .gitattributes to mark _version.py + for export-subst keyword substitution. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + files = [manifest_in, versionfile_source] + if ipy: + files.append(ipy) + try: + me = __file__ + if me.endswith(".pyc") or me.endswith(".pyo"): + me = os.path.splitext(me)[0] + ".py" + versioneer_file = os.path.relpath(me) + except NameError: + versioneer_file = "versioneer.py" + files.append(versioneer_file) + present = False + try: + f = open(".gitattributes", "r") + for line in f.readlines(): + if line.strip().startswith(versionfile_source): + if "export-subst" in line.strip().split()[1:]: + present = True + f.close() + except EnvironmentError: + pass + if not present: + f = open(".gitattributes", "a+") + f.write("%s export-subst\n" % versionfile_source) + f.close() + files.append(".gitattributes") + run_command(GITS, ["add", "--"] + files) + + +def versions_from_parentdir(parentdir_prefix, root, verbose): + """Try to determine the version from the parent directory name. + + Source tarballs conventionally unpack into a directory that includes both + the project name and a version string. We will also support searching up + two directory levels for an appropriately named parent directory + """ + rootdirs = [] + + for i in range(3): + dirname = os.path.basename(root) + if dirname.startswith(parentdir_prefix): + return {"version": dirname[len(parentdir_prefix):], + "full-revisionid": None, + "dirty": False, "error": None, "date": None} + else: + rootdirs.append(root) + root = os.path.dirname(root) # up a level + + if verbose: + print("Tried directories %s but none started with prefix %s" % + (str(rootdirs), parentdir_prefix)) + raise NotThisMethod("rootdir doesn't start with parentdir_prefix") + + +SHORT_VERSION_PY = """ +# This file was generated by 'versioneer.py' (0.18) from +# revision-control system data, or from the parent directory name of an +# unpacked source archive. Distribution tarballs contain a pre-generated copy +# of this file. + +import json + +version_json = ''' +%s +''' # END VERSION_JSON + + +def get_versions(): + return json.loads(version_json) +""" + + +def versions_from_file(filename): + """Try to determine the version from _version.py if present.""" + try: + with open(filename) as f: + contents = f.read() + except EnvironmentError: + raise NotThisMethod("unable to read _version.py") + mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", + contents, re.M | re.S) + if not mo: + mo = re.search(r"version_json = '''\r\n(.*)''' # END VERSION_JSON", + contents, re.M | re.S) + if not mo: + raise NotThisMethod("no version_json in _version.py") + return json.loads(mo.group(1)) + + +def write_to_version_file(filename, versions): + """Write the given version number to the given _version.py file.""" + os.unlink(filename) + contents = json.dumps(versions, sort_keys=True, + indent=1, separators=(",", ": ")) + with open(filename, "w") as f: + f.write(SHORT_VERSION_PY % contents) + + print("set %s to '%s'" % (filename, versions["version"])) + + +def plus_or_dot(pieces): + """Return a + if we don't already have one, else return a .""" + if "+" in pieces.get("closest-tag", ""): + return "." + return "+" + + +def render_pep440(pieces): + """Build up version string, with post-release "local version identifier". + + Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you + get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty + + Exceptions: + 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += plus_or_dot(pieces) + rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0+untagged.%d.g%s" % (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_pre(pieces): + """TAG[.post.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post.devDISTANCE + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += ".post.dev%d" % pieces["distance"] + else: + # exception #1 + rendered = "0.post.dev%d" % pieces["distance"] + return rendered + + +def render_pep440_post(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX] . + + The ".dev0" means dirty. Note that .dev0 sorts backwards + (a dirty tree will appear "older" than the corresponding clean one), + but you shouldn't be releasing software with -dirty anyways. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%s" % pieces["short"] + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += "+g%s" % pieces["short"] + return rendered + + +def render_pep440_old(pieces): + """TAG[.postDISTANCE[.dev0]] . + + The ".dev0" means dirty. + + Eexceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + return rendered + + +def render_git_describe(pieces): + """TAG[-DISTANCE-gHEX][-dirty]. + + Like 'git describe --tags --dirty --always'. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render_git_describe_long(pieces): + """TAG-DISTANCE-gHEX[-dirty]. + + Like 'git describe --tags --dirty --always -long'. + The distance/hash is unconditional. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render(pieces, style): + """Render the given version pieces into the requested style.""" + if pieces["error"]: + return {"version": "unknown", + "full-revisionid": pieces.get("long"), + "dirty": None, + "error": pieces["error"], + "date": None} + + if not style or style == "default": + style = "pep440" # the default + + if style == "pep440": + rendered = render_pep440(pieces) + elif style == "pep440-pre": + rendered = render_pep440_pre(pieces) + elif style == "pep440-post": + rendered = render_pep440_post(pieces) + elif style == "pep440-old": + rendered = render_pep440_old(pieces) + elif style == "git-describe": + rendered = render_git_describe(pieces) + elif style == "git-describe-long": + rendered = render_git_describe_long(pieces) + else: + raise ValueError("unknown style '%s'" % style) + + return {"version": rendered, "full-revisionid": pieces["long"], + "dirty": pieces["dirty"], "error": None, + "date": pieces.get("date")} + + +class VersioneerBadRootError(Exception): + """The project root directory is unknown or missing key files.""" + + +def get_versions(verbose=False): + """Get the project version from whatever source is available. + + Returns dict with two keys: 'version' and 'full'. + """ + if "versioneer" in sys.modules: + # see the discussion in cmdclass.py:get_cmdclass() + del sys.modules["versioneer"] + + root = get_root() + cfg = get_config_from_root(root) + + assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg" + handlers = HANDLERS.get(cfg.VCS) + assert handlers, "unrecognized VCS '%s'" % cfg.VCS + verbose = verbose or cfg.verbose + assert cfg.versionfile_source is not None, \ + "please set versioneer.versionfile_source" + assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" + + versionfile_abs = os.path.join(root, cfg.versionfile_source) + + # extract version from first of: _version.py, VCS command (e.g. 'git + # describe'), parentdir. This is meant to work for developers using a + # source checkout, for users of a tarball created by 'setup.py sdist', + # and for users of a tarball/zipball created by 'git archive' or github's + # download-from-tag feature or the equivalent in other VCSes. + + get_keywords_f = handlers.get("get_keywords") + from_keywords_f = handlers.get("keywords") + if get_keywords_f and from_keywords_f: + try: + keywords = get_keywords_f(versionfile_abs) + ver = from_keywords_f(keywords, cfg.tag_prefix, verbose) + if verbose: + print("got version from expanded keyword %s" % ver) + return ver + except NotThisMethod: + pass + + try: + ver = versions_from_file(versionfile_abs) + if verbose: + print("got version from file %s %s" % (versionfile_abs, ver)) + return ver + except NotThisMethod: + pass + + from_vcs_f = handlers.get("pieces_from_vcs") + if from_vcs_f: + try: + pieces = from_vcs_f(cfg.tag_prefix, root, verbose) + ver = render(pieces, cfg.style) + if verbose: + print("got version from VCS %s" % ver) + return ver + except NotThisMethod: + pass + + try: + if cfg.parentdir_prefix: + ver = versions_from_parentdir(cfg.parentdir_prefix, root, verbose) + if verbose: + print("got version from parentdir %s" % ver) + return ver + except NotThisMethod: + pass + + if verbose: + print("unable to compute version") + + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, "error": "unable to compute version", + "date": None} + + +def get_version(): + """Get the short version string for this project.""" + return get_versions()["version"] + + +def get_cmdclass(): + """Get the custom setuptools/distutils subclasses used by Versioneer.""" + if "versioneer" in sys.modules: + del sys.modules["versioneer"] + # this fixes the "python setup.py develop" case (also 'install' and + # 'easy_install .'), in which subdependencies of the main project are + # built (using setup.py bdist_egg) in the same python process. Assume + # a main project A and a dependency B, which use different versions + # of Versioneer. A's setup.py imports A's Versioneer, leaving it in + # sys.modules by the time B's setup.py is executed, causing B to run + # with the wrong versioneer. Setuptools wraps the sub-dep builds in a + # sandbox that restores sys.modules to it's pre-build state, so the + # parent is protected against the child's "import versioneer". By + # removing ourselves from sys.modules here, before the child build + # happens, we protect the child from the parent's versioneer too. + # Also see https://github.com/warner/python-versioneer/issues/52 + + cmds = {} + + # we add "version" to both distutils and setuptools + from distutils.core import Command + + class cmd_version(Command): + description = "report generated version string" + user_options = [] + boolean_options = [] + + def initialize_options(self): + pass + + def finalize_options(self): + pass + + def run(self): + vers = get_versions(verbose=True) + print("Version: %s" % vers["version"]) + print(" full-revisionid: %s" % vers.get("full-revisionid")) + print(" dirty: %s" % vers.get("dirty")) + print(" date: %s" % vers.get("date")) + if vers["error"]: + print(" error: %s" % vers["error"]) + cmds["version"] = cmd_version + + # we override "build_py" in both distutils and setuptools + # + # most invocation pathways end up running build_py: + # distutils/build -> build_py + # distutils/install -> distutils/build ->.. + # setuptools/bdist_wheel -> distutils/install ->.. + # setuptools/bdist_egg -> distutils/install_lib -> build_py + # setuptools/install -> bdist_egg ->.. + # setuptools/develop -> ? + # pip install: + # copies source tree to a tempdir before running egg_info/etc + # if .git isn't copied too, 'git describe' will fail + # then does setup.py bdist_wheel, or sometimes setup.py install + # setup.py egg_info -> ? + + # we override different "build_py" commands for both environments + if "setuptools" in sys.modules: + from setuptools.command.build_py import build_py as _build_py + else: + from distutils.command.build_py import build_py as _build_py + + class cmd_build_py(_build_py): + def run(self): + root = get_root() + cfg = get_config_from_root(root) + versions = get_versions() + _build_py.run(self) + # now locate _version.py in the new build/ directory and replace + # it with an updated value + if cfg.versionfile_build: + target_versionfile = os.path.join(self.build_lib, + cfg.versionfile_build) + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, versions) + cmds["build_py"] = cmd_build_py + + if "cx_Freeze" in sys.modules: # cx_freeze enabled? + from cx_Freeze.dist import build_exe as _build_exe + # nczeczulin reports that py2exe won't like the pep440-style string + # as FILEVERSION, but it can be used for PRODUCTVERSION, e.g. + # setup(console=[{ + # "version": versioneer.get_version().split("+", 1)[0], # FILEVERSION + # "product_version": versioneer.get_version(), + # ... + + class cmd_build_exe(_build_exe): + def run(self): + root = get_root() + cfg = get_config_from_root(root) + versions = get_versions() + target_versionfile = cfg.versionfile_source + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, versions) + + _build_exe.run(self) + os.unlink(target_versionfile) + with open(cfg.versionfile_source, "w") as f: + LONG = LONG_VERSION_PY[cfg.VCS] + f.write(LONG % + {"DOLLAR": "$", + "STYLE": cfg.style, + "TAG_PREFIX": cfg.tag_prefix, + "PARENTDIR_PREFIX": cfg.parentdir_prefix, + "VERSIONFILE_SOURCE": cfg.versionfile_source, + }) + cmds["build_exe"] = cmd_build_exe + del cmds["build_py"] + + if 'py2exe' in sys.modules: # py2exe enabled? + try: + from py2exe.distutils_buildexe import py2exe as _py2exe # py3 + except ImportError: + from py2exe.build_exe import py2exe as _py2exe # py2 + + class cmd_py2exe(_py2exe): + def run(self): + root = get_root() + cfg = get_config_from_root(root) + versions = get_versions() + target_versionfile = cfg.versionfile_source + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, versions) + + _py2exe.run(self) + os.unlink(target_versionfile) + with open(cfg.versionfile_source, "w") as f: + LONG = LONG_VERSION_PY[cfg.VCS] + f.write(LONG % + {"DOLLAR": "$", + "STYLE": cfg.style, + "TAG_PREFIX": cfg.tag_prefix, + "PARENTDIR_PREFIX": cfg.parentdir_prefix, + "VERSIONFILE_SOURCE": cfg.versionfile_source, + }) + cmds["py2exe"] = cmd_py2exe + + # we override different "sdist" commands for both environments + if "setuptools" in sys.modules: + from setuptools.command.sdist import sdist as _sdist + else: + from distutils.command.sdist import sdist as _sdist + + class cmd_sdist(_sdist): + def run(self): + versions = get_versions() + self._versioneer_generated_versions = versions + # unless we update this, the command will keep using the old + # version + self.distribution.metadata.version = versions["version"] + return _sdist.run(self) + + def make_release_tree(self, base_dir, files): + root = get_root() + cfg = get_config_from_root(root) + _sdist.make_release_tree(self, base_dir, files) + # now locate _version.py in the new base_dir directory + # (remembering that it may be a hardlink) and replace it with an + # updated value + target_versionfile = os.path.join(base_dir, cfg.versionfile_source) + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, + self._versioneer_generated_versions) + cmds["sdist"] = cmd_sdist + + return cmds + + +CONFIG_ERROR = """ +setup.cfg is missing the necessary Versioneer configuration. You need +a section like: + + [versioneer] + VCS = git + style = pep440 + versionfile_source = src/myproject/_version.py + versionfile_build = myproject/_version.py + tag_prefix = + parentdir_prefix = myproject- + +You will also need to edit your setup.py to use the results: + + import versioneer + setup(version=versioneer.get_version(), + cmdclass=versioneer.get_cmdclass(), ...) + +Please read the docstring in ./versioneer.py for configuration instructions, +edit setup.cfg, and re-run the installer or 'python versioneer.py setup'. +""" + +SAMPLE_CONFIG = """ +# See the docstring in versioneer.py for instructions. Note that you must +# re-run 'versioneer.py setup' after changing this section, and commit the +# resulting files. + +[versioneer] +#VCS = git +#style = pep440 +#versionfile_source = +#versionfile_build = +#tag_prefix = +#parentdir_prefix = + +""" + +INIT_PY_SNIPPET = """ +from ._version import get_versions +__version__ = get_versions()['version'] +del get_versions +""" + + +def do_setup(): + """Main VCS-independent setup function for installing Versioneer.""" + root = get_root() + try: + cfg = get_config_from_root(root) + except (EnvironmentError, configparser.NoSectionError, + configparser.NoOptionError) as e: + if isinstance(e, (EnvironmentError, configparser.NoSectionError)): + print("Adding sample versioneer config to setup.cfg", + file=sys.stderr) + with open(os.path.join(root, "setup.cfg"), "a") as f: + f.write(SAMPLE_CONFIG) + print(CONFIG_ERROR, file=sys.stderr) + return 1 + + print(" creating %s" % cfg.versionfile_source) + with open(cfg.versionfile_source, "w") as f: + LONG = LONG_VERSION_PY[cfg.VCS] + f.write(LONG % {"DOLLAR": "$", + "STYLE": cfg.style, + "TAG_PREFIX": cfg.tag_prefix, + "PARENTDIR_PREFIX": cfg.parentdir_prefix, + "VERSIONFILE_SOURCE": cfg.versionfile_source, + }) + + ipy = os.path.join(os.path.dirname(cfg.versionfile_source), + "__init__.py") + if os.path.exists(ipy): + try: + with open(ipy, "r") as f: + old = f.read() + except EnvironmentError: + old = "" + if INIT_PY_SNIPPET not in old: + print(" appending to %s" % ipy) + with open(ipy, "a") as f: + f.write(INIT_PY_SNIPPET) + else: + print(" %s unmodified" % ipy) + else: + print(" %s doesn't exist, ok" % ipy) + ipy = None + + # Make sure both the top-level "versioneer.py" and versionfile_source + # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so + # they'll be copied into source distributions. Pip won't be able to + # install the package without this. + manifest_in = os.path.join(root, "MANIFEST.in") + simple_includes = set() + try: + with open(manifest_in, "r") as f: + for line in f: + if line.startswith("include "): + for include in line.split()[1:]: + simple_includes.add(include) + except EnvironmentError: + pass + # That doesn't cover everything MANIFEST.in can do + # (http://docs.python.org/2/distutils/sourcedist.html#commands), so + # it might give some false negatives. Appending redundant 'include' + # lines is safe, though. + if "versioneer.py" not in simple_includes: + print(" appending 'versioneer.py' to MANIFEST.in") + with open(manifest_in, "a") as f: + f.write("include versioneer.py\n") + else: + print(" 'versioneer.py' already in MANIFEST.in") + if cfg.versionfile_source not in simple_includes: + print(" appending versionfile_source ('%s') to MANIFEST.in" % + cfg.versionfile_source) + with open(manifest_in, "a") as f: + f.write("include %s\n" % cfg.versionfile_source) + else: + print(" versionfile_source already in MANIFEST.in") + + # Make VCS-specific changes. For git, this means creating/changing + # .gitattributes to mark _version.py for export-subst keyword + # substitution. + do_vcs_install(manifest_in, cfg.versionfile_source, ipy) + return 0 + + +def scan_setup_py(): + """Validate the contents of setup.py against Versioneer's expectations.""" + found = set() + setters = False + errors = 0 + with open("setup.py", "r") as f: + for line in f.readlines(): + if "import versioneer" in line: + found.add("import") + if "versioneer.get_cmdclass()" in line: + found.add("cmdclass") + if "versioneer.get_version()" in line: + found.add("get_version") + if "versioneer.VCS" in line: + setters = True + if "versioneer.versionfile_source" in line: + setters = True + if len(found) != 3: + print("") + print("Your setup.py appears to be missing some important items") + print("(but I might be wrong). Please make sure it has something") + print("roughly like the following:") + print("") + print(" import versioneer") + print(" setup( version=versioneer.get_version(),") + print(" cmdclass=versioneer.get_cmdclass(), ...)") + print("") + errors += 1 + if setters: + print("You should remove lines like 'versioneer.VCS = ' and") + print("'versioneer.versionfile_source = ' . This configuration") + print("now lives in setup.cfg, and should be removed from setup.py") + print("") + errors += 1 + return errors + + +if __name__ == "__main__": + cmd = sys.argv[1] + if cmd == "setup": + errors = do_setup() + errors += scan_setup_py() + if errors: + sys.exit(1)