Соглашение Python для обозначения переменных для обозначения единиц

Question

Во-первых, когда я спрашиваю об элементах, я имею в виду единицы измерения, такие как дюймы, футы, пиксели, ячейки. Я не имею в виду типы данных, такие как int и float.

Wikipedia относится к этому как логического типа данных, а нетипа физические данные.

Я хотел бы знать, как лучше всего использовать переменные.

Вот код, чтобы пройти через то, что я спрашиваю:

board_length=8 #in inches 
board_length=8*12 #Convert from feet to inches 

Обратите внимание, что эти оба целые числа (или поплавки, я не забочусь), но я изменил единицы. Я также сохранил имя переменной одинаково. Я мог бы создать конвенцию, и это цель этого вопроса. Без руководства я мог бы сделать что-то вроде этого:

board_length=8 
board_length_inches=8*12 

Я бы счел это случайным способом делать вещи. Или, я мог бы установить соглашение:

Fboard_length=8 
Iboard_length=8*12 

Или другие варианты, которые мне в равной степени не нравятся. Как я могу назвать переменные описательным образом, но остаюсь как можно ближе к PEP-08?

Просто чтобы быть ясно, как я могу, переменные могут иметь различные типы данных, но эти подразделения будут одни и те же (в дюймах будет иметь тот же именование, независимо от того, если он был сохранен, как и целое число или число с плавающей точкой)

Answer 1

Я бы пошел дальше и имел отдельные типы объектов, обеспечивающие безопасность типа, а не просто полагающиеся на соглашения об именах. В противном случае вы можете передать переменную, представляющую дюймы, в метод, требующий миль.

Я думаю, что, опираясь на именование будет проблематично поддерживать длительный срок и сделать использование типов даст вам гораздо больше гибкости и безопасности (например, обеспечивающее преобразование и т.д., встроенное в типы объектов)

Answer 2

Если вам нужна более надежная поддержка устройства, вы должны проверить PyPi's Pint module. Он не имеет прямого отношения к вашему вопросу об именовании, но может потребоваться большая часть работы с частыми преобразованиями. Вы можете найти информацию о нем и некоторых других модулях единицы здесь:

http://www.drdobbs.com/jvm/quantities-and-units-in-python/240161101

Answer 3

В то время как вы могли бы придумать именование, вы могли бы лучше строить объект, представляющий «расстояние» со свойствами для чтения/пишите в разных единицах. Например:

class Distance(object): 

    def __init__(self): 
     self._inches = 0 

    @property 
    def inches(self): 
     return self._inches 

    @inches.setter 
    def inches(self, value): 
     self._inches = value 

    @property 
    def feet(self): 
     return self._inches/12 

    @feet.setter 
    def feet(self, value): 
     self._inches = value * 12 

Вы даже можете сделать его более универсальным, чтобы вы могли легко расширить его с помощью новых преобразований. (Примечание: Отредактировано для того, чтобы оформить заметку на основе комментариев)

from collections import defaultdict 

class Distance(object): 

    _conversion_map = defaultdict(lambda: {'to' : None, 'from' : None}) 

    def __init__(self, **kwargs): 
     self._memo = {} 
     if kwargs: 
      unit, value = kwargs.iteritems().next() 
      if unit == 'inches': 
       self.inches = value 
      else: 
       setattr(self, unit, value) 
     else: 
      self.inches = 0 

    def __getattr__(self, name): 
     if name in self._conversion_map: 
      try: 
       return self._memo[name] 
      except KeyError: 
       converter = self._conversion_map[name]['to'] 
       if converter is None: 
        raise AttributeError 
       converted = converter(self.inches) 
       self._memo[name] = converted 
       return converted 
     else: 
      raise AttributeError 

    def __setattr__(self, name, value): 
     if name == '_memo': 
      super(Distance, self).__setattr__(name, value) 
     else: 
      # Clear memoized values if setting the value of the object 
      self._memo = {} 
     if name == 'inches': 
      super(Distance, self).__setattr__(name, value) 
     if name in self._conversion_map: 
      converter = self._conversion_map[name]['from'] 
      if converter is None: 
       raise AttributeError 
      self._memo[name] = value 
      self.inches = converter(value) 
     else: 
      raise AttributeError 

    @classmethod 
    def converter(cls, func): 
     direction, unit = func.__name__.split('_', 1) 
     cls._conversion_map[unit][direction] = func 
     return func 

@Distance.converter 
def to_feet(value): 
    return value/12 

@Distance.converter 
def from_feet(value): 
    return value * 12 

board_1_length = Distance(feet=2) 
board_2_length = Distance(inches=14) 
board_1_length.inches # 24 
board_2_length.feet # 1 (integer division)