Initial commit / MVP

e55d3983 · Anton Sarukhanov · e55d3983 · e55d3983 · e55d3983 · e55d3983
Commit e55d3983 authored 5 years ago by Anton Sarukhanov
--- a/.flaskenv
+++ b/.flaskenv
+FLASK_APP=whatformat/app.py
--- a/.gitignore
+++ b/.gitignore
+.flake8
+.mypy_cache/
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
+image: python:3-buster
+
+before_script:
+  - pip install -r requirements-dev.txt
+
+test:
+    script:
+    - bandit whatformat/*.py whatformat/util/*.py
+    - flake8 --config=.flake8 whatformat/*.py whatformat/util/*.py
+    - mypy whatformat/*.py whatformat/util/*.py
+    - pydocstyle whatformat/*.py whatformat/util/*.py
+    - pylint whatformat/*.py whatformat/util/*.py
--- a/README.md
+++ b/README.md
+# What Format
+
+What Format is a tool for identifying the date/time [format string](https://strftime.org/) for any date.
+
+## Stack
+
+- Python3
+- Flask
+- DateUtil
+
+# Development Setup
+
+- `pip install -r requirements-dev.txt`
+- `flask run`
--- a/mypy.ini
+++ b/mypy.ini
+[mypy]
+files = whatformat/**/*.py
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
+-r requirements.txt
+bandit==1.6.2
+flake8==3.7.9
+mypy==0.750
+pydocstyle==4.0.1
+pylint==2.4.4
+python-dotenv==0.10.3
--- a/requirements.txt
+++ b/requirements.txt
+python-dateutil==2.8.1
+Flask==1.1.1
--- a/whatformat/__init__.py
+++ b/whatformat/__init__.py
+"""What Format app."""
--- a/whatformat/app.py
+++ b/whatformat/app.py
+"""Flask app for What Format."""
+
+from flask import Flask, jsonify, render_template, request
+from whatformat.util import whatdateformat
+
+# pylint: disable=invalid-name ; These variables are standard for Flask.
+app = Flask(__name__)
+
+
+@app.route('/')
+def landing():
+    """Render the homepage."""
+    date_string = request.args.get('date')
+    return render_template('landing.html', date_string=date_string)
+
+
+@app.route('/date')
+def date():
+    """Return date format strings matching date_string."""
+    date_string = request.args.get('date')
+    return jsonify(whatdateformat.get_unique_format_strings(date_string))
--- a/whatformat/static/script.js
+++ b/whatformat/static/script.js
+function throttle(func, time) {
+    clearTimeout(func._timeout);
+    func._timeout=setTimeout(() => { func.call(); }, time);
+}
+
+function handle_date_change(e) {
+    async function _handle_date_change() {
+        var response = await fetch('/date?date=' + encodeURIComponent(e.target.value));
+        var response_json = await response.json();
+        format_strings = '';
+        for (entry in response_json) {
+            format_strings += '<p>' + response_json[entry] + '</p>';
+        }
+        document.querySelector('#format').innerHTML = format_strings;
+    }
+    throttle((e) => { _handle_date_change(e); }, 100);
+}
+
+var date_input = document.querySelector('#date');
+date_input.addEventListener('focus', handle_date_change, false);
+date_input.addEventListener('change', handle_date_change, false);
+date_input.addEventListener('keydown', handle_date_change, false);
+date_input.focus();
--- a/whatformat/static/style.css
+++ b/whatformat/static/style.css
+body {
+    background-color: #333;
+    color: #eee;
+    margin: 1em;
+    text-align: center;
+}
+
+header a:link,
+header a:visited,
+header a:active {
+    color: #888;
+    text-decoration: none;
+}
+
+a:link,
+a:visited,
+a:active {
+    color: #eee;
+}
+
+p, form {
+    margin: 1em;
+}
+
+form#detect-format input {
+    display: block;
+    width: 100%;
+    font-size: 1.75em;
+    padding: .25em;
+    box-sizing: border-box;
+    text-align: center;
+}
+
+#format p {
+    border: 4px dashed #666;
+    border-radius: 10px;
+    padding: .5em;
+    margin-top: 1.5em;
+    font-size: 1.5em;
+    font-weight: bold;
+}
--- a/whatformat/templates/landing.html
+++ b/whatformat/templates/landing.html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>What Format</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link href="/static/style.css" rel="stylesheet" />
+    <meta name="description" content="Detect Python date format from an existing date." />
+</head>
+<body>
+    <header>
+        <h1><a href="/">What Format</a></h1>
+    </header>
+    <main>
+        <p>
+            Auto-detect the <a href="https://strftime.org/" target="_blank">Format String</a> of your date.
+        </p>
+        <form id="detect-format"><input id="date" name="date" value="{{ date_string if date_string }}" placeholder="January 1, 2000"/></form>
+        <section id="format">
+        </section>
+    </main>
+    <script src="/static/script.js"></script>
+</body>
+</html>
--- a/whatformat/util/__init__.py
+++ b/whatformat/util/__init__.py
+"""Supporting utilities for the What Format app."""
--- a/whatformat/util/whatdateformat.py
+++ b/whatformat/util/whatdateformat.py
+"""Function(s) for getting a format string from a date string."""
+
+import re
+from itertools import product
+from collections import defaultdict, Counter
+from typing import Dict, Iterator, List
+from dateutil.parser import parse, ParserError  # type: ignore
+
+FORMAT_DIRECTIVES = [
+    '%a', '%A', '%w', '%d', '%b', '%B', '%m', '%y', '%Y',
+    '%H', '%I', '%p', '%M', '%S', '%f', '%z', '%Z', '%j',
+    '%U', '%W', '%c', '%x', '%X', '%%',
+    '%-d', '%-m', '%-H', '%-I', '%-M', '%-S', '%-j']
+
+DATE_TOKEN_REGEX = re.compile(r'([\w]+)|([\W]+)')
+
+
+# pylint: disable=too-many-locals
+def get_all_format_strings(date_string, allow_reuse=False,
+                           no_zero=False) -> Iterator[str]:
+    """Yield date format strings which match date_string."""
+    try:
+        parsed_datetime = parse(date_string)
+    except ParserError:
+        yield ''
+    tokens = DATE_TOKEN_REGEX.findall(date_string)
+    possible_matches = defaultdict(list)  # type: Dict[str, List[str]]
+    for test_format in FORMAT_DIRECTIVES:
+        test_string = parsed_datetime.strftime(test_format)
+        possible_matches[test_string.lower()].append(test_format)
+        possible_parts = []
+        for (token, delimiter) in tokens:
+            if token:
+                if token.lower() in possible_matches:
+                    possible_parts.append(
+                        possible_matches[token.lower()])
+            else:
+                possible_parts.append([delimiter])
+
+        possible_combinations = list(product(*possible_parts))
+        for parts_sequence in possible_combinations:
+            if not no_zero and any(['%-' in x for x in parts_sequence]):
+                without_zero = [x.replace('%-', '%') for x in parts_sequence]
+                if without_zero in possible_combinations:
+                    continue
+            if not allow_reuse:
+                counts = Counter(parts_sequence)
+                max_count = max(
+                    counts[diretive] for diretive in FORMAT_DIRECTIVES)
+                if max_count > 1:
+                    continue
+            format_string = "".join(parts_sequence)
+            if parsed_datetime.strftime(
+                    format_string).lower() == date_string.lower():
+                yield format_string
+
+
+def get_unique_format_strings(date_string, allow_reuse=False) -> List[str]:
+    """Return date format strings matching date_string, without duplicates."""
+    return list(set(get_all_format_strings(date_string, allow_reuse)))