This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
devicehub-teal/ereuse_devicehub/resources/device/models.py

830 lines
28 KiB
Python
Raw Normal View History

import csv
2018-09-30 17:40:28 +00:00
import pathlib
2018-04-27 17:16:43 +00:00
from contextlib import suppress
from fractions import Fraction
from itertools import chain
from operator import attrgetter
2018-10-03 12:51:22 +00:00
from typing import Dict, List, Set
2018-04-27 17:16:43 +00:00
from boltons import urlutils
2018-09-30 17:40:28 +00:00
from citext import CIText
from ereuse_utils.naming import HID_CONVERSION_DOC, Naming
from more_itertools import unique_everseen
from sqlalchemy import BigInteger, Boolean, Column, Enum as DBEnum, Float, ForeignKey, Integer, \
Sequence, SmallInteger, Unicode, inspect, text
2018-04-10 15:06:39 +00:00
from sqlalchemy.ext.declarative import declared_attr
from sqlalchemy.ext.hybrid import hybrid_property
2018-06-26 13:36:21 +00:00
from sqlalchemy.orm import ColumnProperty, backref, relationship, validates
from sqlalchemy.util import OrderedSet
2018-06-10 16:47:49 +00:00
from sqlalchemy_utils import ColorType
2018-06-26 13:36:21 +00:00
from stdnum import imei, meid
from teal.db import CASCADE_DEL, POLYMORPHIC_ID, POLYMORPHIC_ON, ResourceNotFound, URL, \
check_lower, check_range
from teal.enums import Layouts
2018-09-07 10:38:02 +00:00
from teal.marshmallow import ValidationError
from teal.resource import url_for_resource
2018-04-10 15:06:39 +00:00
2018-09-30 17:40:28 +00:00
from ereuse_devicehub.db import db
from ereuse_devicehub.resources.enums import BatteryTechnology, ComputerChassis, \
DataStorageInterface, DisplayTech, PrinterTechnology, RamFormat, RamInterface, Severity
from ereuse_devicehub.resources.models import STR_SM_SIZE, Thing
2018-07-02 10:52:54 +00:00
2018-04-10 15:06:39 +00:00
class Device(Thing):
"""Base class for any type of physical object that can be identified.
Device partly extends `Schema's IndividualProduct <https
://schema.org/IndividualProduct>`_, adapting it to our
use case.
A device requires an identification method, ideally a serial number,
although it can be identified only with tags too. More ideally
both methods are used.
Devices can contain ``Components``, which are just a type of device
(it is a recursive relationship).
"""
EVENT_SORT_KEY = attrgetter('created')
2018-06-10 16:47:49 +00:00
id = Column(BigInteger, Sequence('device_seq'), primary_key=True)
2018-06-20 21:18:15 +00:00
id.comment = """
The identifier of the device for this database. Used only
internally for software; users should not use this.
2018-06-20 21:18:15 +00:00
"""
type = Column(Unicode(STR_SM_SIZE), nullable=False)
hid = Column(Unicode(), check_lower('hid'), unique=True)
2018-06-20 21:18:15 +00:00
hid.comment = """
The Hardware ID (HID) is the unique ID traceability systems
use to ID a device globally. This field is auto-generated
from Devicehub using literal identifiers from the device,
so it can re-generated *offline*.
2019-02-05 16:59:15 +00:00
""" + HID_CONVERSION_DOC
model = Column(Unicode, check_lower('model'))
model.comment = """The model of the device in lower case.
The model is the unambiguous, as technical as possible, denomination
for the product. This field, among others, is used to identify
the product.
"""
manufacturer = Column(Unicode(), check_lower('manufacturer'))
manufacturer.comment = """The normalized name of the manufacturer,
in lower case.
Although as of now Devicehub does not enforce normalization,
users can choose a list of normalized manufacturer names
from the own ``/manufacturers`` REST endpoint.
"""
serial_number = Column(Unicode(), check_lower('serial_number'))
serial_number.comment = """The serial number of the device in lower case."""
brand = db.Column(CIText())
brand.comment = """A naming for consumers. This field can represent
several models, so it can be ambiguous, and it is not used to
identify the product.
"""
generation = db.Column(db.SmallInteger, check_range('generation', 0))
generation.comment = """The generation of the device."""
weight = Column(Float(decimal_return_scale=3), check_range('weight', 0.1, 5))
2018-06-20 21:18:15 +00:00
weight.comment = """
The weight of the device.
2018-06-20 21:18:15 +00:00
"""
width = Column(Float(decimal_return_scale=3), check_range('width', 0.1, 5))
2018-06-20 21:18:15 +00:00
width.comment = """
The width of the device in meters.
2018-06-20 21:18:15 +00:00
"""
height = Column(Float(decimal_return_scale=3), check_range('height', 0.1, 5))
2018-06-20 21:18:15 +00:00
height.comment = """
The height of the device in meters.
2018-06-20 21:18:15 +00:00
"""
depth = Column(Float(decimal_return_scale=3), check_range('depth', 0.1, 5))
depth.comment = """
The depth of the device in meters.
"""
2018-06-10 16:47:49 +00:00
color = Column(ColorType)
color.comment = """The predominant color of the device."""
production_date = Column(db.DateTime)
production_date.comment = """The date of production of the device.
This is timezone naive, as Workbench cannot report this data
with timezone information.
"""
variant = Column(Unicode)
variant.comment = """A variant or sub-model of the device."""
_NON_PHYSICAL_PROPS = {
'id',
'type',
'created',
'updated',
'parent_id',
'hid',
'production_date',
'color', # these are only user-input thus volatile
'width',
'height',
'depth',
'weight',
'brand',
'generation',
'production_date',
'variant'
}
2018-04-27 17:16:43 +00:00
__table_args__ = (
db.Index('device_id', id, postgresql_using='hash'),
db.Index('type_index', type, postgresql_using='hash')
)
def __init__(self, **kw) -> None:
super().__init__(**kw)
with suppress(TypeError):
2019-01-02 16:52:43 +00:00
self.hid = Naming.hid(self.type, self.manufacturer, self.model, self.serial_number)
@property
def events(self) -> list:
2018-06-10 16:47:49 +00:00
"""
All the events where the device participated, including:
1. Events performed directly to the device.
2. Events performed to a component.
3. Events performed to a parent device.
Events are returned by descending ``created`` time.
2018-06-10 16:47:49 +00:00
"""
return sorted(chain(self.events_multiple, self.events_one), key=self.EVENT_SORT_KEY)
@property
def problems(self):
"""Current events with severity.Warning or higher.
There can be up to 3 events: current Snapshot,
current Physical event, current Trading event.
"""
from ereuse_devicehub.resources.device import states
from ereuse_devicehub.resources.event.models import Snapshot
events = set()
with suppress(LookupError, ValueError):
events.add(self.last_event_of(Snapshot))
with suppress(LookupError, ValueError):
events.add(self.last_event_of(*states.Physical.events()))
with suppress(LookupError, ValueError):
events.add(self.last_event_of(*states.Trading.events()))
return self._warning_events(events)
2018-04-30 17:58:19 +00:00
2018-04-27 17:16:43 +00:00
@property
2018-04-30 17:58:19 +00:00
def physical_properties(self) -> Dict[str, object or None]:
2018-04-27 17:16:43 +00:00
"""
Fields that describe the physical properties of a device.
:return A generator where each value is a tuple with tho fields:
- Column.
- Actual value of the column or None.
"""
# todo ensure to remove materialized values when start using them
# todo or self.__table__.columns if inspect fails
2018-04-30 17:58:19 +00:00
return {c.key: getattr(self, c.key, None)
2018-04-27 17:16:43 +00:00
for c in inspect(self.__class__).attrs
2018-04-30 17:58:19 +00:00
if isinstance(c, ColumnProperty)
and not getattr(c, 'foreign_keys', None)
and c.key not in self._NON_PHYSICAL_PROPS}
2018-04-10 15:06:39 +00:00
@property
def url(self) -> urlutils.URL:
"""The URL where to GET this device."""
return urlutils.URL(url_for_resource(Device, item_id=self.id))
@property
def rate(self):
"""The last AggregateRate of the device."""
with suppress(LookupError, ValueError):
from ereuse_devicehub.resources.event.models import AggregateRate
return self.last_event_of(AggregateRate)
@property
def price(self):
"""The actual Price of the device, or None if no price has
ever been set."""
with suppress(LookupError, ValueError):
from ereuse_devicehub.resources.event.models import Price
return self.last_event_of(Price)
@property
def trading(self):
"""The actual trading state, or None if no Trade event has
ever been performed to this device."""
from ereuse_devicehub.resources.device import states
with suppress(LookupError, ValueError):
event = self.last_event_of(*states.Trading.events())
return states.Trading(event.__class__)
@property
def physical(self):
"""The actual physical state, None otherwise."""
from ereuse_devicehub.resources.device import states
with suppress(LookupError, ValueError):
event = self.last_event_of(*states.Physical.events())
return states.Physical(event.__class__)
@property
def physical_possessor(self):
"""The actual physical possessor or None.
The physical possessor is the Agent that has physically
the device. It differs from legal owners, usufructuarees
or reserves in that the physical possessor does not have
a legal relation per se with the device, but it is the one
that has it physically. As an example, a transporter could
be a physical possessor of a device although it does not
own it legally.
Note that there can only be one physical possessor per device,
and :class:`ereuse_devicehub.resources.event.models.Receive`
changes it.
"""
from ereuse_devicehub.resources.event.models import Receive
with suppress(LookupError):
event = self.last_event_of(Receive)
return event.agent
@property
def working(self):
"""A list of the current tests with warning or errors. A
device is working if the list is empty.
This property returns, for the last test performed of each type,
the one with the worst ``severity`` of them, or ``None`` if no
test has been executed.
"""
from ereuse_devicehub.resources.event.models import Test
current_tests = unique_everseen((e for e in reversed(self.events) if isinstance(e, Test)),
key=attrgetter('type')) # last test of each type
return self._warning_events(current_tests)
2018-04-10 15:06:39 +00:00
@declared_attr
def __mapper_args__(cls):
"""
Defines inheritance.
From `the guide <http://docs.sqlalchemy.org/en/latest/orm/
extensions/declarative/api.html
#sqlalchemy.ext.declarative.declared_attr>`_
"""
args = {POLYMORPHIC_ID: cls.t}
if cls.t == 'Device':
2018-04-10 15:06:39 +00:00
args[POLYMORPHIC_ON] = cls.type
return args
def last_event_of(self, *types):
"""Gets the last event of the given types.
:raise LookupError: Device has not an event of the given type.
"""
try:
# noinspection PyTypeHints
return next(e for e in reversed(self.events) if isinstance(e, types))
except StopIteration:
raise LookupError('{!r} does not contain events of types {}.'.format(self, types))
def _warning_events(self, events):
return sorted((ev for ev in events if ev.severity >= Severity.Warning),
key=self.EVENT_SORT_KEY)
2018-04-30 17:58:19 +00:00
def __lt__(self, other):
return self.id < other.id
2018-04-27 17:16:43 +00:00
2018-10-03 12:51:22 +00:00
def __str__(self) -> str:
return '{0.t} {0.id}: model {0.model}, S/N {0.serial_number}'.format(self)
def __format__(self, format_spec):
if not format_spec:
return super().__format__(format_spec)
v = ''
if 't' in format_spec:
v += '{0.t} {0.model}'.format(self)
if 's' in format_spec:
2018-10-16 14:30:10 +00:00
v += '({0.manufacturer})'.format(self)
if self.serial_number:
v += ' S/N ' + self.serial_number.upper()
2018-10-03 12:51:22 +00:00
return v
2018-04-10 15:06:39 +00:00
2018-06-26 13:36:21 +00:00
class DisplayMixin:
"""Base class for the Display Component and the Monitor Device."""
size = Column(Float(decimal_return_scale=1), check_range('size', 2, 150), nullable=False)
2018-06-26 13:36:21 +00:00
size.comment = """
The size of the monitor in inches.
"""
technology = Column(DBEnum(DisplayTech))
technology.comment = """
The technology the monitor uses to display the image.
"""
resolution_width = Column(SmallInteger, check_range('resolution_width', 10, 20000),
nullable=False)
2018-06-26 13:36:21 +00:00
resolution_width.comment = """
The maximum horizontal resolution the monitor can natively support
in pixels.
"""
resolution_height = Column(SmallInteger, check_range('resolution_height', 10, 20000),
nullable=False)
2018-06-26 13:36:21 +00:00
resolution_height.comment = """
The maximum vertical resolution the monitor can natively support
in pixels.
"""
refresh_rate = Column(SmallInteger, check_range('refresh_rate', 10, 1000))
contrast_ratio = Column(SmallInteger, check_range('contrast_ratio', 100, 100000))
touchable = Column(Boolean)
touchable.comment = """Whether it is a touchscreen."""
2018-06-26 13:36:21 +00:00
@hybrid_property
def aspect_ratio(self):
"""The aspect ratio of the display, as a fraction: ``X/Y``.
Regular values are ``4/3``, ``5/4``, ``16/9``, ``21/9``,
``14/10``, ``19/10``, ``16/10``.
"""
return Fraction(self.resolution_width, self.resolution_height)
# noinspection PyUnresolvedReferences
@aspect_ratio.expression
def aspect_ratio(cls):
# The aspect ratio to use as SQL in the DB
# This allows comparing resolutions
return db.func.round(cls.resolution_width / cls.resolution_height, 2)
@hybrid_property
def widescreen(self):
"""Whether the monitor is considered to be widescreen.
Widescreen monitors are those having a higher aspect ratio
greater than 4/3.
"""
# We add a tiny extra to 4/3 to avoid precision errors
return self.aspect_ratio > 4.001 / 3
def __str__(self) -> str:
return '{0.t} {0.serial_number} {0.size}in ({0.aspect_ratio}) {0.technology}'.format(self)
2018-10-03 12:51:22 +00:00
def __format__(self, format_spec: str) -> str:
v = ''
if 't' in format_spec:
v += '{0.t} {0.model}'.format(self)
if 's' in format_spec:
v += '({0.manufacturer}) S/N {0.serial_number}'.format(self)
v += ' {0.size}in ({0.aspect_ratio}) {0.technology}'.format(self)
2018-10-03 12:51:22 +00:00
return v
2018-06-26 13:36:21 +00:00
2018-04-10 15:06:39 +00:00
class Computer(Device):
"""A chassis with components inside that can be processed
automatically with Workbench Computer.
Computer is broadly extended by ``Desktop``, ``Laptop``, and
``Server``. The property ``chassis`` defines it more granularly.
"""
2018-06-10 16:47:49 +00:00
id = Column(BigInteger, ForeignKey(Device.id), primary_key=True)
2018-06-26 13:36:21 +00:00
chassis = Column(DBEnum(ComputerChassis), nullable=False)
chassis.comment = """The physical form of the computer.
It is a subset of the Linux definition of DMI / DMI decode.
"""
2018-04-10 15:06:39 +00:00
2018-10-18 08:09:10 +00:00
def __init__(self, chassis, **kwargs) -> None:
chassis = ComputerChassis(chassis)
super().__init__(chassis=chassis, **kwargs)
@property
def events(self) -> list:
return sorted(chain(super().events, self.events_parent), key=self.EVENT_SORT_KEY)
2018-10-03 12:51:22 +00:00
@property
def ram_size(self) -> int:
"""The total of RAM memory the computer has."""
return sum(ram.size or 0 for ram in self.components if isinstance(ram, RamModule))
2018-10-03 12:51:22 +00:00
@property
def data_storage_size(self) -> int:
"""The total of data storage the computer has."""
return sum(ds.size or 0 for ds in self.components if isinstance(ds, DataStorage))
2018-10-03 12:51:22 +00:00
@property
def processor_model(self) -> str:
"""The model of one of the processors of the computer."""
return next((p.model for p in self.components if isinstance(p, Processor)), None)
2018-10-03 12:51:22 +00:00
@property
def graphic_card_model(self) -> str:
"""The model of one of the graphic cards of the computer."""
return next((p.model for p in self.components if isinstance(p, GraphicCard)), None)
2018-10-03 12:51:22 +00:00
@property
def network_speeds(self) -> List[int]:
"""Returns two values representing the speeds of the network
adapters of the device.
1. The max Ethernet speed of the computer, 0 if ethernet
adaptor exists but its speed is unknown, None if no eth
adaptor exists.
2. The max WiFi speed of the computer, 0 if computer has
WiFi but its speed is unknown, None if no WiFi adaptor
exists.
2018-10-03 12:51:22 +00:00
"""
speeds = [None, None]
2018-10-03 12:51:22 +00:00
for net in (c for c in self.components if isinstance(c, NetworkAdapter)):
speeds[net.wireless] = max(net.speed or 0, speeds[net.wireless] or 0)
2018-10-03 12:51:22 +00:00
return speeds
@property
def privacy(self):
"""Returns the privacy of all ``DataStorage`` components when
it is not None.
"""
return set(
privacy for privacy in
(hdd.privacy for hdd in self.components if isinstance(hdd, DataStorage))
if privacy
)
2018-10-03 12:51:22 +00:00
def __format__(self, format_spec):
if not format_spec:
return super().__format__(format_spec)
v = ''
if 't' in format_spec:
v += '{0.chassis} {0.model}'.format(self)
elif 's' in format_spec:
2018-10-16 14:30:10 +00:00
v += '({0.manufacturer})'.format(self)
if self.serial_number:
v += ' S/N ' + self.serial_number.upper()
2018-10-03 12:51:22 +00:00
return v
2018-04-10 15:06:39 +00:00
class Desktop(Computer):
pass
class Laptop(Computer):
layout = Column(DBEnum(Layouts))
layout.comment = """Layout of a built-in keyboard of the computer,
if any."""
2018-04-10 15:06:39 +00:00
2018-06-26 13:36:21 +00:00
class Server(Computer):
2018-04-10 15:06:39 +00:00
pass
2018-06-26 13:36:21 +00:00
class Monitor(DisplayMixin, Device):
id = Column(BigInteger, ForeignKey(Device.id), primary_key=True)
class ComputerMonitor(Monitor):
2018-04-10 15:06:39 +00:00
pass
2018-06-26 13:36:21 +00:00
class TelevisionSet(Monitor):
2018-04-10 15:06:39 +00:00
pass
class Projector(Monitor):
pass
2018-06-26 13:36:21 +00:00
class Mobile(Device):
"""A mobile device consisting of smartphones, tablets, and cellphones."""
2018-06-20 21:18:15 +00:00
id = Column(BigInteger, ForeignKey(Device.id), primary_key=True)
2018-06-26 13:36:21 +00:00
imei = Column(BigInteger)
imei.comment = """The International Mobile Equipment Identity of
the smartphone as an integer.
2018-06-20 21:18:15 +00:00
"""
2018-06-26 13:36:21 +00:00
meid = Column(Unicode)
meid.comment = """The Mobile Equipment Identifier as a hexadecimal
string.
2018-06-20 21:18:15 +00:00
"""
ram_size = db.Column(db.Integer, check_range(1, ))
ram_size.comment = """The total of RAM of the device in MB."""
data_storage_size = db.Column(db.Integer)
2018-06-20 21:18:15 +00:00
2018-06-26 13:36:21 +00:00
@validates('imei')
def validate_imei(self, _, value: int):
if not imei.is_valid(str(value)):
2018-06-26 13:36:21 +00:00
raise ValidationError('{} is not a valid imei.'.format(value))
return value
2018-06-26 13:36:21 +00:00
@validates('meid')
def validate_meid(self, _, value: str):
if not meid.is_valid(value):
raise ValidationError('{} is not a valid meid.'.format(value))
return value
2018-06-26 13:36:21 +00:00
class Smartphone(Mobile):
pass
class Tablet(Mobile):
pass
class Cellphone(Mobile):
pass
2018-06-20 21:18:15 +00:00
2018-04-10 15:06:39 +00:00
class Component(Device):
"""A device that can be inside another device."""
2018-06-10 16:47:49 +00:00
id = Column(BigInteger, ForeignKey(Device.id), primary_key=True)
2018-04-10 15:06:39 +00:00
parent_id = Column(BigInteger, ForeignKey(Computer.id))
2018-04-10 15:06:39 +00:00
parent = relationship(Computer,
backref=backref('components',
lazy=True,
cascade=CASCADE_DEL,
order_by=lambda: Component.id,
collection_class=OrderedSet),
2018-06-15 13:31:03 +00:00
primaryjoin=parent_id == Computer.id)
2018-04-27 17:16:43 +00:00
__table_args__ = (
db.Index('parent_index', parent_id, postgresql_using='hash'),
)
2018-04-27 17:16:43 +00:00
def similar_one(self, parent: Computer, blacklist: Set[int]) -> 'Component':
"""
Gets a component that:
- has the same parent.
- Doesn't generate HID.
- Has same physical properties.
:param parent:
:param blacklist: A set of components to not to consider
when looking for similar ones.
"""
assert self.hid is None, 'Don\'t use this method with a component that has HID'
component = self.__class__.query \
.filter_by(parent=parent, hid=None, **self.physical_properties) \
.filter(~Component.id.in_(blacklist)) \
.first()
if not component:
raise ResourceNotFound(self.type)
return component
2018-04-10 15:06:39 +00:00
@property
def events(self) -> list:
return sorted(chain(super().events, self.events_components), key=self.EVENT_SORT_KEY)
class JoinedComponentTableMixin:
@declared_attr
def id(cls):
return Column(BigInteger, ForeignKey(Component.id), primary_key=True)
2018-04-10 15:06:39 +00:00
class GraphicCard(JoinedComponentTableMixin, Component):
2018-06-10 16:47:49 +00:00
memory = Column(SmallInteger, check_range('memory', min=1, max=10000))
2018-06-26 13:36:21 +00:00
memory.comment = """
The amount of memory of the Graphic Card in MB.
"""
2018-06-10 16:47:49 +00:00
2018-04-10 15:06:39 +00:00
2018-06-10 16:47:49 +00:00
class DataStorage(JoinedComponentTableMixin, Component):
"""A device that stores information."""
2018-06-10 16:47:49 +00:00
size = Column(Integer, check_range('size', min=1, max=10 ** 8))
2018-06-26 13:36:21 +00:00
size.comment = """
The size of the data-storage in MB.
"""
2018-06-12 14:50:05 +00:00
interface = Column(DBEnum(DataStorageInterface))
2018-04-10 15:06:39 +00:00
@property
def privacy(self):
2018-12-30 11:43:29 +00:00
"""Returns the privacy compliance state of the data storage.
This is, the last erasure performed to the data storage.
"""
from ereuse_devicehub.resources.event.models import EraseBasic
try:
ev = self.last_event_of(EraseBasic)
except LookupError:
ev = None
return ev
2018-10-03 12:51:22 +00:00
def __format__(self, format_spec):
v = super().__format__(format_spec)
if 's' in format_spec:
v += ' {} GB'.format(self.size // 1000 if self.size else '?')
2018-10-03 12:51:22 +00:00
return v
2018-06-10 16:47:49 +00:00
class HardDrive(DataStorage):
pass
class SolidStateDrive(DataStorage):
pass
2018-04-10 15:06:39 +00:00
class Motherboard(JoinedComponentTableMixin, Component):
2018-07-02 10:52:54 +00:00
slots = Column(SmallInteger, check_range('slots', min=0))
2018-06-26 13:36:21 +00:00
slots.comment = """
PCI slots the motherboard has.
"""
2018-07-02 10:52:54 +00:00
usb = Column(SmallInteger, check_range('usb', min=0))
firewire = Column(SmallInteger, check_range('firewire', min=0))
serial = Column(SmallInteger, check_range('serial', min=0))
pcmcia = Column(SmallInteger, check_range('pcmcia', min=0))
bios_date = Column(db.Date)
bios_date.comment = """The date of the BIOS version."""
2018-04-10 15:06:39 +00:00
2018-06-26 13:35:13 +00:00
class NetworkMixin:
2018-06-10 16:47:49 +00:00
speed = Column(SmallInteger, check_range('speed', min=10, max=10000))
2018-06-26 13:35:13 +00:00
speed.comment = """
The maximum speed this network adapter can handle, in mbps.
"""
wireless = Column(Boolean, nullable=False, default=False)
wireless.comment = """
Whether it is a wireless interface.
"""
2018-06-26 13:35:13 +00:00
2018-10-03 12:51:22 +00:00
def __format__(self, format_spec):
v = super().__format__(format_spec)
if 's' in format_spec:
v += ' {} Mbps'.format(self.speed)
return v
2018-06-26 13:35:13 +00:00
class NetworkAdapter(JoinedComponentTableMixin, NetworkMixin, Component):
pass
2018-04-27 17:16:43 +00:00
class Processor(JoinedComponentTableMixin, Component):
"""The CPU."""
speed = Column(Float, check_range('speed', 0.1, 15))
speed.comment = """The regular CPU speed."""
cores = Column(SmallInteger, check_range('cores', 1, 10))
cores.comment = """The number of regular cores."""
threads = Column(SmallInteger, check_range('threads', 1, 20))
threads.comment = """The number of threads per core."""
address = Column(SmallInteger, check_range('address', 8, 256))
address.comment = """The address of the CPU: 8, 16, 32, 64, 128 or 256 bits."""
abi = Column(Unicode, check_lower('abi'))
abi.comment = """The Application Binary Interface of the processor."""
class RamModule(JoinedComponentTableMixin, Component):
"""A stick of RAM."""
2018-04-27 17:16:43 +00:00
size = Column(SmallInteger, check_range('size', min=128, max=17000))
size.comment = """The capacity of the RAM stick."""
speed = Column(SmallInteger, check_range('speed', min=100, max=10000))
2018-06-12 14:50:05 +00:00
interface = Column(DBEnum(RamInterface))
format = Column(DBEnum(RamFormat))
2018-06-26 13:36:21 +00:00
2018-07-02 10:52:54 +00:00
class SoundCard(JoinedComponentTableMixin, Component):
pass
2018-06-26 13:36:21 +00:00
class Display(JoinedComponentTableMixin, DisplayMixin, Component):
"""
The display of a device. This is used in all devices that have
displays but that it is not their main part, like laptops,
mobiles, smart-watches, and so on; excluding ``ComputerMonitor``
and ``TelevisionSet``.
2018-06-26 13:36:21 +00:00
"""
pass
2018-09-30 17:40:28 +00:00
class Battery(JoinedComponentTableMixin, Component):
wireless = db.Column(db.Boolean)
wireless.comment = """If the battery can be charged wirelessly."""
technology = db.Column(db.Enum(BatteryTechnology))
size = db.Column(db.Integer, nullable=False)
size.comment = """Maximum battery capacity by design, in mAh.
Use BatteryTest's "size" to get the actual size of the battery.
"""
@property
def capacity(self) -> float:
"""The quantity of """
from ereuse_devicehub.resources.event.models import MeasureBattery
real_size = self.last_event_of(MeasureBattery).size
return real_size / self.size if real_size and self.size else None
class ComputerAccessory(Device):
"""Computer peripherals and similar accessories."""
id = Column(BigInteger, ForeignKey(Device.id), primary_key=True)
pass
class SAI(ComputerAccessory):
pass
class Keyboard(ComputerAccessory):
layout = Column(DBEnum(Layouts)) # If we want to do it not null
class Mouse(ComputerAccessory):
pass
class MemoryCardReader(ComputerAccessory):
pass
class Networking(NetworkMixin, Device):
"""Routers, switches, hubs..."""
id = Column(BigInteger, ForeignKey(Device.id), primary_key=True)
class Router(Networking):
pass
class Switch(Networking):
pass
class Hub(Networking):
pass
class WirelessAccessPoint(Networking):
pass
class Printer(Device):
id = Column(BigInteger, ForeignKey(Device.id), primary_key=True)
wireless = Column(Boolean, nullable=False, default=False)
wireless.comment = """Whether it is a wireless printer."""
scanning = Column(Boolean, nullable=False, default=False)
scanning.comment = """Whether the printer has scanning capabilities."""
technology = Column(DBEnum(PrinterTechnology))
technology.comment = """Technology used to print."""
monochrome = Column(Boolean, nullable=False, default=True)
monochrome.comment = """Whether the printer is only monochrome."""
class LabelPrinter(Printer):
pass
class Sound(Device):
pass
class Microphone(Sound):
pass
class Video(Device):
"""Devices related to video treatment."""
pass
class VideoScaler(Video):
pass
class Videoconference(Video):
pass
2018-11-12 10:59:49 +00:00
class Cooking(Device):
"""Cooking devices."""
2018-11-12 10:59:49 +00:00
pass
class Mixer(Cooking):
pass
2018-09-30 17:40:28 +00:00
class Manufacturer(db.Model):
"""The normalized information about a manufacturer.
Ideally users should use the names from this list when submitting
devices.
"""
CSV_DELIMITER = csv.get_dialect('excel').delimiter
2018-09-30 17:40:28 +00:00
name = db.Column(CIText(), primary_key=True)
name.comment = """The normalized name of the manufacturer."""
2018-09-30 17:40:28 +00:00
url = db.Column(URL(), unique=True)
url.comment = """An URL to a page describing the manufacturer."""
2018-09-30 17:40:28 +00:00
logo = db.Column(URL())
logo.comment = """An URL pointing to the logo of the manufacturer."""
2018-09-30 17:40:28 +00:00
__table_args__ = (
# from https://niallburkley.com/blog/index-columns-for-like-in-postgres/
db.Index('name_index', text('name gin_trgm_ops'), postgresql_using='gin'),
{'schema': 'common'}
)
2018-09-30 17:40:28 +00:00
@classmethod
def add_all_to_session(cls, session: db.Session):
2018-09-30 17:40:28 +00:00
"""Adds all manufacturers to session."""
cursor = session.connection().connection.cursor()
#: Dialect used to write the CSV
with pathlib.Path(__file__).parent.joinpath('manufacturers.csv').open() as f:
cursor.copy_expert(
'COPY common.manufacturer FROM STDIN (FORMAT csv)',
f
)