33

我正在创建一个查询构建器类，该类将有助于从 URL 参数构建对 mongodb 的查询。除了使用基本的语言结构和使用 django 的内置模型之外，我从来没有做过太多的面向对象编程，也没有设计过供我以外的人使用的类。

所以我有这QueryBuilder门课

class QueryHelper():
    """
    Help abstract out the problem of querying over vastly
    different dataschemas.
    """

    def __init__(self, collection_name, field_name, params_dict):
        self.query_dict = {}
        self.params_dict = params_dict
        db = connection.get_db()
        self.collection = db[collection_name]

    def _build_query(self):
        # check params dict and build a mongo query
        pass

现在，_build_query我将检查params_dict并填充query_dict，以便将其传递给 mongo 的find()函数。在这样做时，我只是想知道是否有绝对正确的方法来确定是否_build_query应该返回字典或是否应该只修改self.query_dict. 由于它是一种内部方法，我认为只需修改self.query_dict. 有没有正确的方法（pythonic）方法来解决这个问题？这只是愚蠢而不是重要的设计决定吗？任何帮助表示赞赏。

4

4 回答 4

15

修改是非常好的，self.query_dict因为面向对象编程的整个想法是方法可以修改对象的状态。只要方法完成后对象处于一致状态，就可以了。这是一种内部方法这一事实_build_query并不重要。您可以选择在创建对象时调用_build_queryafter in__init__来构造查询。

该决定主要用于测试目的。出于测试目的，可以方便地单独测试每个方法，而不必测试整个对象的状态。但这不适用于这种情况，因为我们谈论的是内部方法，因此您独自决定何时调用该方法，而不是其他对象或其他代码。

于 2012-06-13T14:49:10.627 回答
13

返回一个值是更可取的，因为它允许您将所有属性修改保留在一个位置 ( __init__)。此外，这使得以后扩展代码更容易；假设你想_build_query在子类中覆盖，那么覆盖方法可以只返回一个值，而不需要知道要设置哪个属性。这是一个例子：

class QueryHelper(object):
    def __init__(self, param, text):
        self._param = param
        self._query = self._build_query(text)

    def _build_query(self, text):
        return text + " and ham!"

class RefinedQueryHelper(QueryHelper):
    def _build_query(self, text):
        # no need to know how the query object is going to be used
        q = super(RefinedQueryHelper, self)._build_query()
        return q.replace("ham", "spam")

与“二传手版本”相比：

class QueryHelper(object):
    def __init__(self, param, text):
        self._param = param
        self._build_query(text)

    def _build_query(self, text):
        self._query = text + " and ham!"

class RefinedQueryHelper(QueryHelper):
    def _build_query(self, text):
        # what if we want to store the query in __query instead?
        # then we need to modify two classes...
        super(RefinedQueryHelper, self)._build_query()
        self._query = self._query.replace("ham", "spam")

如果您确实选择设置属性，则可能需要调用该方法_set_query以清楚起见。

于 2012-06-13T14:57:29.417 回答
10

如果您返回任何东西，我建议self。从实例方法返回self对于方法链接来说很方便，因为每个返回值都允许在同一个对象上调用另一个方法：

foo.add_thing(x).add_thing(y).set_goal(42).execute()

这有时被称为“流利的”API。

int然而，虽然 Python 允许对诸如and之类的不可变类型进行方法链接str，但它并没有为诸如listand之类的可变容器的方法提供它——根据set设计——因此为你自己的可变类型这样做可以说不是“Pythonic”。尽管如此，许多 Python 库确实具有“流畅”的 API。

缺点是这样的 API 会使调试变得更加困难。由于您执行整个语句或不执行任何语句，因此您无法轻松地在语句的中间点看到对象。当然，我通常发现print完全可以调试 Python 代码，所以我只需print在任何我感兴趣的返回值的方法中抛出一个！

于 2012-06-13T15:00:38.407 回答
6

虽然对象的方法直接修改其状态是很常见的，但有时将对象作为自己的“客户端”并通过（通常）私有访问方法间接访问自己可能是有利的。在 Python 中，您可以使用内置的property()类/函数轻松完成此操作。

这样做提供了更好的封装和随之而来的好处（主要是实现细节的隔离）。然而，这样做可能是不切实际的，因为它需要太多额外的代码并且通常速度较慢，这可能会对性能产生不可接受的负面影响——因此必须经常根据这个理想进行权衡。

于 2012-06-13T15:06:42.670 回答