Blame view

flaskr/models.py 4.5 KB
16f69d07   Antoine Goutenoir   Add an (unsecured...
1
2
from flask_admin.contrib.sqla import ModelView

a3e9d0fc   Antoine Goutenoir   Fix home plot leg...
3
from flaskr.core import generate_unique_id, models
1b39d5ec   Goutte   Add a skeleton fo...
4
5
6
from flask_sqlalchemy import SQLAlchemy
from flask_login import UserMixin, AnonymousUserMixin
from werkzeug.security import generate_password_hash, check_password_hash
6a9e49da   Antoine Goutenoir   Load the output a...
7
from yaml import safe_load as yaml_load
97fe903e   Goutte   Add the base data...
8
import enum
1b39d5ec   Goutte   Add a skeleton fo...
9

c10e71f4   Antoine Goutenoir   Document the models.
10
11
12
13
14
15
16
# These are not the emission "models" in the scientific meaning of the word.
# They are the SQL Database Models.
# These are also named Entities, in other conventions (we're following flasks")
# If you're looking for the Emission Models (aka scaling laws),
# look in `flaskr/laws/`.


1b39d5ec   Goutte   Add a skeleton fo...
17
18
19
db = SQLAlchemy()


c10e71f4   Antoine Goutenoir   Document the models.
20
21
class StatusEnum(enum.Enum):
    pending = 'pending'
03c194bf   Antoine Goutenoir   Actually implemen...
22
    working = 'working'
c10e71f4   Antoine Goutenoir   Document the models.
23
    success = 'success'
5b6d9d3d   Antoine Goutenoir   Add a method to t...
24
    failure = 'failure'
c10e71f4   Antoine Goutenoir   Document the models.
25
26


a1f12452   Antoine Goutenoir   Add the new conte...
27
28
29
30
31
32
33
class ScenarioEnum(enum.Enum):
    one_to_one = 'one_to_one'
    many_to_one = 'many_to_one'
    one_to_many = 'one_to_many'
    many_to_many = 'many_to_many'


c10e71f4   Antoine Goutenoir   Document the models.
34
35
class Estimation(db.Model):
    id = db.Column(db.Integer(), primary_key=True)
fa3d2b43   Antoine Goutenoir   Conflate the data...
36
37
38
39
40
    public_id = db.Column(
        db.Unicode(),
        default=lambda: generate_unique_id(),
        unique=True
    )
c10e71f4   Antoine Goutenoir   Document the models.
41
42
43
    email = db.Column(db.Unicode(1024))
    first_name = db.Column(db.Unicode(1024))  # Antoine
    last_name = db.Column(db.Unicode(1024))   # Goutenoir
16f69d07   Antoine Goutenoir   Add an (unsecured...
44
    institution = db.Column(db.Unicode(1024))   # IRAP
fa3d2b43   Antoine Goutenoir   Conflate the data...
45
    status = db.Column(db.Enum(StatusEnum), default=StatusEnum.pending)
c10e71f4   Antoine Goutenoir   Document the models.
46
47
48

    # City, Country
    # One address per line
16f69d07   Antoine Goutenoir   Add an (unsecured...
49
50
    origin_addresses = db.Column(db.UnicodeText())
    destination_addresses = db.Column(db.UnicodeText())
c10e71f4   Antoine Goutenoir   Document the models.
51

322609d8   Antoine Goutenoir   Prepare the Emiss...
52
53
54
    # For (single, not round) trips below this distance, use the train
    use_train_below_km = db.Column(db.Integer())

a1f12452   Antoine Goutenoir   Add the new conte...
55
    # One slug per line (or blank char?)
466912a2   Antoine Goutenoir   Prepare the estim...
56
57
58
    models_slugs = db.Column(db.UnicodeText())

    # Deprecated, we detect this scenario from the amount of locations.
c10e71f4   Antoine Goutenoir   Document the models.
59
60
    compute_optimal_destination = db.Column(db.Boolean())

a1f12452   Antoine Goutenoir   Add the new conte...
61
62
    # Outputs
    scenario = db.Column(db.Enum(ScenarioEnum), default=ScenarioEnum.many_to_many)
77a9e740   Antoine Goutenoir   Pickling is overk...
63
    output_yaml = db.Column(db.UnicodeText())
fa3d2b43   Antoine Goutenoir   Conflate the data...
64
65
66
    warnings = db.Column(db.UnicodeText())
    errors = db.Column(db.UnicodeText())

5b6d9d3d   Antoine Goutenoir   Add a method to t...
67
68
    def has_failed(self):
        return self.status == StatusEnum.failure
c10e71f4   Antoine Goutenoir   Document the models.
69

a3e9d0fc   Antoine Goutenoir   Fix home plot leg...
70
71
    _output_dict = None

6a9e49da   Antoine Goutenoir   Load the output a...
72
    def get_output_dict(self):
a3e9d0fc   Antoine Goutenoir   Fix home plot leg...
73
        if self._output_dict is None:
ca35720c   Antoine Goutenoir   Fix typo.
74
            if self.output_yaml is None:
37e28f2c   Antoine Goutenoir   Improve resilience.
75
76
77
                self._output_dict = None
            else:
                self._output_dict = yaml_load(self.output_yaml)
a1f12452   Antoine Goutenoir   Add the new conte...
78
            return self._output_dict
a1f12452   Antoine Goutenoir   Add the new conte...
79
80
81
82
83
84
85
86
87

    def is_one_to_one(self):
        return self.scenario == ScenarioEnum.one_to_one

    def is_one_to_many(self):
        return self.scenario == ScenarioEnum.one_to_many

    def is_many_to_one(self):
        return self.scenario == ScenarioEnum.many_to_one
6a9e49da   Antoine Goutenoir   Load the output a...
88

a1f12452   Antoine Goutenoir   Add the new conte...
89
90
    def is_many_to_many(self):
        return self.scenario == ScenarioEnum.many_to_many
f3694728   Antoine Goutenoir   Display a summary.
91

a3e9d0fc   Antoine Goutenoir   Fix home plot leg...
92
93
94
95
96
97
98
99
    _models = None

    def get_models(self):
        if self._models is None:
            mdl_slugs = self.models_slugs.split("\n")
            self._models = [m for m in models if m.slug in mdl_slugs]
        return self._models

6a9e49da   Antoine Goutenoir   Load the output a...
100

16f69d07   Antoine Goutenoir   Add an (unsecured...
101
102
103
104
105
106
107
class EstimationView(ModelView):
    # Show only name and email columns in list view
    column_list = (
        'public_id',
        'status',
        'first_name',
        'last_name',
466912a2   Antoine Goutenoir   Prepare the estim...
108
        'models_slugs',
a1f12452   Antoine Goutenoir   Add the new conte...
109
        'scenario',
16f69d07   Antoine Goutenoir   Add an (unsecured...
110
111
112
113
114
115
116
117
118
119
        'origin_addresses',
        'destination_addresses',
        'warnings',
        'errors',
    )

    # Enable search functionality - it will search for terms in
    # name and email fields
    # column_searchable_list = ('name', 'email')

16f69d07   Antoine Goutenoir   Add an (unsecured...
120
121
122
    column_filters = ('first_name', 'last_name')


c10e71f4   Antoine Goutenoir   Document the models.
123
124
# USERS #######################################################################

1b39d5ec   Goutte   Add a skeleton fo...
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
class User(db.Model, UserMixin):
    id = db.Column(db.Integer(), primary_key=True)
    username = db.Column(db.String())
    password = db.Column(db.String())

    def __init__(self, username, password):
        self.username = username
        self.set_password(password)

    def set_password(self, password):
        self.password = generate_password_hash(password)

    def check_password(self, value):
        return check_password_hash(self.password, value)

    @property
    def is_authenticated(self):
        if isinstance(self, AnonymousUserMixin):
            return False
        else:
            return True

    def is_active(self):
        return True

    def is_anonymous(self):
        if isinstance(self, AnonymousUserMixin):
            return True
        else:
            return False

    def get_id(self):
        return self.id

    def __repr__(self):
fa3d2b43   Antoine Goutenoir   Conflate the data...
160
        return '<User %r>' % self.username