navmazing 1.2.2

简介

支持复杂设计的简单导航框架

设计

navmazing基于多个导航步骤，这些步骤是NavigateStep对象的子类。这些步骤对象通过定义一个前提方法相互关联，如果确定我们不在请求的步骤上，则该方法可以跳转到前一个步骤。从第一个步骤开始，遍历链中的所有前提步骤直到解决，构成完整的导航。

使用方法

以下是一个示例。这创建了一个简单的类，模拟某个Provider对象，该对象在UI中具有三个目的地或页面，分别是：新建页面、详情页面和全部页面。在新建页面中，可以添加新的Provider，在全部页面中可以查看所有Provider的列表。要访问新建页面，必须首先访问全部页面。在详情页面中会显示特定的Provider。在下面的示例中，可以看到我们模拟了一些非常简单的步骤并将它们注册到类中。

from navmazing import Navigate, NavigateStep, NavigateToSibling

navigator = Navigate()

class Provider(object):
    def __init__(self, name):
        self.name = name

@navigator.register(Provider, 'Details')
class ProviderDetails(NavigateStep):
    prerequisite = NavigateToSibling('All')

    def step(self):
        click(self.obj.name)

@navigator.register(Provider, 'New')
class AddANewProvider(NavigateStep):
    prerequisite = NavigateToSibling('All')

    def step(self):
        click('Add New Button')

@navigator.register(Provider, 'All')
class ShowAllProviders(NavigateStep):
    def am_i_here(self):
        return check_if_i_am_already_on_page()

    def step(self):
        click('All button')

类ShowAllProviders表示访问全部页面的步骤。这个类有两个方法，am_i_here()和step()。step()方法描述了如何执行访问全部页面的步骤。在这个特定的UI中，假设全部按钮总是可见的。am_i_here()方法是一种查询方法，用于检查我们是否已经在这个页面上。如果可以确定我们已经在一个请求访问的页面上，这可以用来简化导航。

类AddANewProvider表示访问新建页面的步骤。这个类有一个属性和一个方法。prerequisite实际上是一个Python描述符。它使用NavigateToSibling辅助器来导航到请求访问新建页面的同一对象上的全部目的地。可以简单地将prerequisite定义为一个函数，该函数调用navigate_to，并传递self.obj和All目的地。然而，辅助器更方便，使得定义先决步骤更加简洁。

类ProviderDetails表示访问特定Provider页面的步骤，即它的详情页面。这个类与AddANewProvider类相同，在它首先需要按下全部按钮。注意在step()方法中，有一个对self.obj的引用。这个对象是传递给导航步骤的对象，如下所示。在下面的示例中，这个对象被称为prov。

# Non helper method
def prerequisite(self):
    navigator.navigate(self.obj, 'All')

# Using helper method
prerequisite = NavigateToSibling('All')

要使用上面的代码，需要实例化一个Provider对象，然后使用navigate方法，如下所示

prov = Provider('name')
navigator.navigate(prov, 'Details')

导航辅助器

navmazing有一些辅助器，使定义先决条件更加容易

• NavigateToSibling - 导航到当前请求对象注册的目的地。

• NavigateToAttribute - 导航到当前请求对象属性注册的目的地。如果有对象层次结构，并且希望导航到注册在属性上的步骤而不是对象本身，这很有用。

• NavigateToObject - 导航到注册到提供的对象的目的地。可以认为通过提供一个NavigateToObject调用，可以使用NavigateToAttribute实现，只需简单地将属性对象作为对象提供。在这种情况下，属性是一个字符串，而不是静态的对象，这感觉更动态和简洁。

流程图

以下图表显示了使用navmazing库解析导航过程的流程图。由于方法是可以重写的，流程可以更改，但应该适用于大多数用法。

高级用法

navmazing 还允许在 navigate 调用时传递参数。这意味着您可以允许导航目的地具有一定的动态性或选择性。例如，假设您有一个通常按一种方式工作的步骤，但在某些时候您需要覆盖该行为并按不同的方式工作。

@navigator.register(Provider, 'Details')
class ProviderDetails(NavigateStep)
    prerequisite = NavigateToSibling('All')

    def step(self, active=True):
        if choice:
            click(self.obj.name)
        else:
            click(self.obj.name + " - inactive")

# Call by default
navigate(obj, 'Details')

# Call, passing in a parameter for choice
navigate(obj, 'Details', active=False)

在上面的示例中，传递 active 参数会改变步骤的行为。