Избыточный код в Django models.py.Как мне улучшить это? - PullRequest
1 голос
/ 08 марта 2012

Я пытаюсь создать список задач, каждая из которых имеет атрибут datetime. Задачи должны быть в порядке: t_created - первое, а t_paid - последнее. Порядок показан в step_datetime. Описание для каждой задачи в STEPS.

В настоящее время у меня есть два метода all_steps и next_step, которые отображают информацию о списке задач. Этим двум методам также необходимо отобразить имя user_created, но эта переменная не будет определена до тех пор, пока методы не будут вызваны. Вот почему я делаю строковый метод replace.

Мне кажется, что я много раз повторяю свой код, и я хочу следовать принципу DRY Django. Можно ли как-нибудь улучшить этот код?

Вот мой полный код:

class Order( models.Model ) :
    def __unicode__( self ) :
        return unicode( self.id )

    def comments_count( self ) :
        return OrderComment.objects.filter( order = self.id ).count()

    def all_steps( self ) :
        user = self.user_created.first_name

        steps = []
        step_datetime = [
            self.t_created,
            self.t_action,
            self.t_followup_one,
            self.t_vendor_appt_one,
            self.t_vendor_appt_two,
            self.t_work_done,
            self.t_followup_two,
            self.t_paid,
        ]

        for ( i, step ) in enumerate( self.STEPS ) :
            steps.append( ( step_datetime[ i ], step.replace( '<user_created>', user ), ) )

        return steps

    def next_step( self ) :
        user = self.user_created.first_name

        step = 0
        if self.t_action is None :
            step = 0
        elif self.t_followup_one is None :
            step = 1
        elif self.t_vendor_appt_one is None :
            step = 2
        elif self.t_vendor_appt_two is None :
            step = 3
        elif self.t_work_done is None :
            step = 4
        elif self.t_followup_two is None :
            step = 5
        elif self.paid is None :
            step = 6

        return str( step ) + ": " + self.STEPS[ step ].replace( '<user_created>', user )


    STEPS = [
        "Review, then either approve or reject the order.",
        "Follow up with <user_created>",
        "Contact the vendor to get a quote and arrange an appointment for <user_created>.",
        "Review the quote, (get owner approval), then arrange a second appointment for the repairs.",
        "Confirm the finished repairs and pay the vendor.",
        "Follow up again with <user_created>",
        "Confirm payment and close the order.",
    ]

    ACTION_CHOICES = (
        ( 'p', 'pending'  ),
        ( 'a', 'approved' ),
        ( 'r', 'rejected' ),
        ( 'c', 'closed'   ),
    )

    user_created      = models.ForeignKey( User, related_name = 'user_created', verbose_name = 'created by' )
    user_action       = models.ForeignKey( User, related_name = 'user_status' , verbose_name = 'action by' , null = True, blank = True )
    t_created         = models.DateTimeField( auto_now_add = True, verbose_name = 'created' )
    t_action          = models.DateTimeField( null = True, blank = True, verbose_name = 'action'             )
    t_followup_one    = models.DateTimeField( null = True, blank = True, verbose_name = 'first follow-up'    )
    t_vendor_appt_one = models.DateTimeField( null = True, blank = True, verbose_name = 'first appointment'  )
    t_vendor_appt_two = models.DateTimeField( null = True, blank = True, verbose_name = 'second appointment' )
    t_work_done       = models.DateTimeField( null = True, blank = True, verbose_name = 'work done'          )
    t_followup_two    = models.DateTimeField( null = True, blank = True, verbose_name = 'second follow-up'   )
    t_paid            = models.DateTimeField( null = True, blank = True, verbose_name = 'paid'               )
    action            = models.CharField( max_length = 1, choices = ACTION_CHOICES, default = 'p' )
    quote             = models.DecimalField( max_digits = 8, decimal_places = 2, null = True, blank = True )
    payment           = models.DecimalField( max_digits = 8, decimal_places = 2, null = True, blank = True )
    items             = models.ManyToManyField( Item, null = True, blank = True )
    t_modified        = models.DateTimeField( auto_now = True, verbose_name = 'modified' )

После принятия @ ответа Дугала . Я изменил некоторые переменные и придумал следующее:

def all_steps( self ) :
    user = self.user_created.first_name

    return [
        ( getattr( self, attr ), task.format( user = user ) )
        for ( attr, task ) in self.TASKS
    ]

def next_step( self ) :
    user = self.user_created.first_name

    task_num = next(
        ( i for ( i, ( attr, task ) ) in enumerate( self.TASKS ) if getattr( self, attr ) is None ),
        None
    )

    if task_num == None :
        return "Done!"
    else:
        return "{number}: {task}".format(
            number = str( task_num + 1 ),
            task   = self.TASKS[ task_num ][ 1 ].format( user = user )
        )

TASKS = (
    ( "t_action"         , "Review, then either approve or reject the order." ),
    ( "t_followup_one"   , "Follow up with {user}." ),
    ( "t_vendor_appt_one", "Contact the vendor to get a quote and arrange an appointment for {user}." ),
    ( "t_vendor_appt_two", "Review the quote, (get owner approval), then arrange a second appointment for the repairs." ),
    ( "t_work_done"      , "Confirm the finished repairs and pay the vendor." ),
    ( "t_followup_two"   , "Follow up again with {user}." ),
    ( "t_paid"           , "Confirm payment and close the order." ),
)

Ответы [ 2 ]

3 голосов
/ 08 марта 2012

Вы можете делать такие вещи, как:

for prop in ("t_created", "t_created2" ... ):
    val = getattr(self, prop)
    # some logic that works with that, maybe uses setattr
2 голосов
/ 08 марта 2012

Добавление к @ ответу Марцина :

Вы можете сделать кортеж из имен свойств (скажем, _STEP_NAMES на уровне модуля; вы также можете сделать это на уровне класса).как STEPS, или даже просто объединить два в кортеж пар атрибутов и имен (это может быть немного чище).Кроме того, STEPS, вероятно, должно быть кортежем, поскольку он не должен быть изменяемым во время выполнения.

Тогда вы можете уменьшить свой код до:

def all_steps(self):
    user = self.user_created.first_name
    return [(getattr(self, attr), step.replace('<user_created>', user))
            for attr, step in zip(_STEP_NAMES, self.STEPS)]

def next_step(self):
    user = self.user_created.first_name
    step = next((i for i, attr in enumerate(_STEP_NAMES)
                        if getattr(self, attr) is None),
                None) # assumes Python 2.6+
    if step == None:
         return "Done!"
    else:
         return str(step) + ": " + self.STEPS[step].replace('<user_created>', user)

Если вам нужен Python 2.4 /2.5 совместимость, строка next может быть заменена на

try:
    step = (i for i, attr in enumerate(_STEP_NAMES) if getattr(self, attr) is None).next()
except StopIteration:
    return "Done!"
return str(step) + ": " + self.STEPS[step].replace('<user_created>', user)
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...