浏览代码

help_text++

blezz-tech 2 月之前
父节点
当前提交
a1f8d5bc33
共有 3 个文件被更改,包括 72 次插入86 次删除
  1. 9 27
      docs/database/relationship.py
  2. 19 17
      docs/database/resource.py
  3. 44 42
      docs/database/service.py

+ 9 - 27
docs/database/relationship.py

@@ -12,37 +12,19 @@ class Relationship():
     id_metaservice = Template.id_metaservice
 
     # DATA
-    neg_type = models.IntegerField(
-        help_text="тип договорных отношений по его уникальному идентификатору"
-    )
-    requirements = models.CharField(
-        max_length=150,
-        help_text="код необходимого (самый строгий) для того, чтобы ресурс мог стать активным. Оно вставляется автоматом, в соответствии с профилем метасервиса. Далее, если кому-то из партнеров или пользователей надо строже - применяется более строгий вариант на данную связь."
-    )
-    status = models.CharField(
-        max_length=150,
-        help_text="(статус обработки заявки в системе заявок)"
-    )
+    neg_type = "тип договорных отношений по его уникальному идентификатору"
+    requirements = "код необходимого (самый строгий) для того, чтобы ресурс мог стать активным. Оно вставляется автоматом, в соответствии с профилем метасервиса. Далее, если кому-то из партнеров или пользователей надо строже - применяется более строгий вариант на данную связь."
+    status = "(статус обработки заявки в системе заявок)"
+    
 
     # OTHER
     is_global = Template.is_global
     is_visible = Template.is_visible
 
     # FK
-    user_id_who = models.ForeignKey(
-        get_user_model(),
-        related_name="user_id_who",
-        on_delete=models.DO_NOTHING,
-        help_text="уникальный идентификатор инициатора договорных отношений"
-    )
-    user_id_whom = models.ForeignKey(
-        get_user_model(),
-        related_name="user_id_whom",
-        on_delete=models.DO_NOTHING,
-        help_text=" уникальный идентификатор того с кем связываются"
-    )
-    ticket_status = models.ForeignKey(
-        Ticket,
-        on_delete=models.DO_NOTHING,
-        help_text="id заявки, по которой происходит проверка статуса relationship. State меняется только в результате изменений в заявке."
+    user_id_who = "уникальный идентификатор инициатора договорных отношений"
+    user_id_whom = "уникальный идентификатор того с кем связываются"
+    ticket_status = (
+        "id заявки, по которой происходит проверка статуса relationship. "
+        "State меняется только в результате изменений в заявке."
     )

+ 19 - 17
docs/database/resource.py

@@ -10,17 +10,18 @@ class Resource():
     id_metaservice = Template.id_metaservice
 
     # DATA
-    resoure_type = models.CharField(
-        max_length=10,
-        help_text="определение типа ресурса по его уникальному идентификатору в соответствии с классификатором"
+    resoure_type = (
+        "определение типа ресурса по его уникальному идентификатору "
+        "в соответствии с классификатором"
     )
-    requirements = models.CharField(
-        max_length=150,
-        help_text="код необходимого (самый строгий) для того, чтобы ресурс мог стать активным"
+    requirements = (
+        "код необходимого (самый строгий) для того, чтобы ресурс "
+        "мог стать активным"
     )
-    status = models.CharField(
-        max_length=150,
-        help_text="статус ресурса в системе относительно прохождения проверок (activity_status) (может быть active только в том случае, если ticket, влияющий на статус - закрыт."
+    status = (
+        "статус ресурса в системе относительно прохождения проверок "
+        "(activity_status) (может быть active только в том случае, если "
+        "ticket, влияющий на статус - закрыт."
     )
 
     # OTHER
@@ -28,13 +29,14 @@ class Resource():
     is_visible = Template.is_visible
 
     # FK
-    ticket_status = models.ForeignKey(
-        Ticket,
-        on_delete=models.DO_NOTHING,
-        help_text="id последнего актуального тикета, касающийся статуса. Если он меняет статус на закрытый - вызывается проверка, которая смотрит, нет ли другого открытого по пользователю."
+    ticket_status = (
+        "id последнего актуального тикета, касающийся статуса. Если он меняет "
+        "статус на закрытый - вызывается проверка, которая смотрит, нет ли "
+        "другого открытого по пользователю."
     )
-    user_id = models.ForeignKey(
-        get_user_model(),
-        on_delete=models.DO_NOTHING,
-        help_text="уникальный идентификатор ответственного (за состояние, доступность и так далее - то есть для договора) пользователя - идентификатор провайдера, по которому восстанавливается конкретный пользовательский аккаунт"
+    user_id = (
+        "уникальный идентификатор ответственного (за состояние, доступность и "
+        "так далее - то есть для договора) пользователя - идентификатор "
+        "провайдера, по которому восстанавливается конкретный "
+        "пользовательский аккаунт"
     )

+ 44 - 42
docs/database/service.py

@@ -12,39 +12,40 @@ class Service():
     id_metaservice = Template.id_metaservice
 
     # DATA
-    price_alg = models.CharField(
-        max_length=100,
-        help_text="шаблон алгоритма расчета цены для оказываемой услуги (по этой переменной определяется, какую функцию для расчета цены вызывать)"
+    price_alg = (
+        "шаблон алгоритма расчета цены для оказываемой услуги (по этой "
+        "переменной определяется, какую функцию для расчета цены вызывать)"
     )
-    price_km = models.DecimalField(
-        max_digits=9,
-        decimal_places=2,
-        help_text="значение параметра стоимости 1км данного поставщика для данного шаблона услуги"
+    price_km = (
+        "значение параметра стоимости 1км данного поставщика для "
+        "данного шаблона услуги"
     )
-    price_min = models.DecimalField(
-        max_digits=9,
-        decimal_places=2,
-        help_text="значение параметра стоимости 1мин данного поставщика для данного шаблона услуги"
+    price_min = (
+        "значение параметра стоимости 1мин данного поставщика для "
+        "данного шаблона услуги"
     )
-    price_amount = models.DecimalField(
-        max_digits=9,
-        decimal_places=2,
-        help_text="значение параметра стоимости 1 услуги данного поставщика для данного шаблона услуги"
+    price_amount = (
+        "значение параметра стоимости 1 услуги данного поставщика для "
+        "данного шаблона услуги"
     )
-    company_comission = models.FloatField(
-        help_text="Коммисия сервиса"
+    company_comission = "Коммисия сервиса"
+    requirements = (
+        "код необходимого (самый строгий) для того, чтобы ресурс мог стать "
+        "активным. Оно вставляется автоматом, в соответствии с профилем "
+        "метасервиса. Далее, если кому-то из партнеров или пользователей "
+        "надо строже - применяется более строгий вариант на данную связь."
     )
-    requirements = models.CharField(
-        max_length=150,
-        help_text="код необходимого (самый строгий) для того, чтобы ресурс мог стать активным. Оно вставляется автоматом, в соответствии с профилем метасервиса. Далее, если кому-то из партнеров или пользователей надо строже - применяется более строгий вариант на данную связь."
+    service_status = (
+        "статус спецификации типа услуги, принимает значения Online, Offline, "
+        "Preorder with Gap. Online/offline выставляются по проверке параметров "
+        "и желанию пользователя (например, если пользователь переключает себя "
+        "online, но по какой-то причине ему такую услугу оказывать запрещено - "
+        "оно не переключится, то есть надо перед сменой значения этого поля "
+        "всегда запускать проверку)"
     )
-    service_status = models.CharField(
-        max_length=150,
-        help_text="статус спецификации типа услуги, принимает значения Online, Offline, Preorder with Gap. Online/offline выставляются по проверке параметров и желанию пользователя (например, если пользователь переключает себя online, но по какой-то причине ему такую услугу оказывать запрещено - оно не переключится, то есть надо перед сменой значения этого поля всегда запускать проверку)"
-    )
-    status = models.CharField(
-        max_length=150,
-        help_text="статус обработки заявки в системе заявок. активность на основе системы заяво"
+    status = (
+        "статус обработки заявки в системе заявок. активность на "
+        "основе системы заяво"
     )
 
     # OTHER
@@ -52,20 +53,21 @@ class Service():
     is_visible = Template.is_visible
 
     # FK
-    ticket_status = models.ForeignKey(
-        Ticket,
-        on_delete=models.DO_NOTHING,
-        help_text="id последнего актуального тикета, касающийся статуса. Если он меняет статус на закрытый - вызывается проверка, которая смотрит, нет ли другого открытого по пользователю."
-    )
-    resource_id = models.ForeignKey(
-        Resource,
-        on_delete=models.DO_NOTHING,
-        blank=True,
-        null=True,
-        help_text="ответственный за ресурс(не всегда). так как ресурсы сами услугу оказать не могут, а также один ресурс может быть представлен в виде разных услуг, то фактически с точки зрения смысла системы ресурс - это как неодушевленный пользователь. Без провайдера, который с его помощью оказывает услугу - никуда. Поле остается пустым, если сервис не предусматривает использование услуг. Стоит обратить внимание, что это не обязательно ответственный за ресурс. Например, за состояние автомобиля может быть ответственен пользователь (он и указывается в таблице со свойствами ресурса), а услугу доступа или перевозки может оказывать иное лицо."
+    ticket_status = (
+        "id последнего актуального тикета, касающийся статуса. Если "
+        "он меняет статус на закрытый - вызывается проверка, которая смотрит, "
+        "нет ли другого открытого по пользователю."
     )
-    servicetype_id = models.ForeignKey(
-        ServiceType,
-        on_delete=models.DO_NOTHING,
-        help_text="тип оказываемой услуги по классификатору услуг сервиса"
+    resource_id = (
+        "ответственный за ресурс(не всегда). так как ресурсы сами "
+        "услугу оказать не могут, а также один ресурс может быть представлен "
+        "в виде разных услуг, то фактически с точки зрения смысла системы "
+        "ресурс - это как неодушевленный пользователь. Без провайдера, "
+        "который с его помощью оказывает услугу - никуда. Поле остается "
+        "пустым, если сервис не предусматривает использование услуг. Стоит "
+        "обратить внимание, что это не обязательно ответственный за ресурс. "
+        "Например, за состояние автомобиля может быть ответственен "
+        "пользователь (он и указывается в таблице со свойствами ресурса), "
+        "а услугу доступа или перевозки может оказывать иное лицо."
     )
+    servicetype_id = "тип оказываемой услуги по классификатору услуг сервиса"