確保兩個Python類具有相同名稱的屬性

Question

我期待在Python中構建類接口，但發現Python缺少接口結構。

我需要的是，如果一個程序員試圖在一個類中增加新的屬性，而無需在另一個類具有相同的名稱添加屬性，一個異常要提高（在編譯時或運行時）

一個例子：如果程序員嘗試將字段添加到MongoCompany不改變ESCompany

class MongoCompany: 
    company_name = MongoField() 

class ESCompany: 
    company_name = ESField() 

一個將引發異常。

class MongoCompany: 
    company_name = MongoField() 
    company_phone = MongoField() 

class ESCompany: 
    company_name = ESField() 

MongoCompany.init() 

編輯：

背景 這是爲了阻止程序員修改與Mongoengine的Document類中聲明MongoDB的模式，而不添加相應的修改，在另一個文件與elasticsearch-DSL的DocType宣佈Elasticsearch的架構類。

Answer 1

耶！元類的實際應用不是爲了使用元類而設計的！我們可以編寫一個元類，如果在類定義中出現意外的屬性，它將拋出。我們所需要做的就是確保你的程序員真正使用它。

class RequiredFieldsMeta(type): 
    _interface = {'company_name', 'num_employees'} 

    def __new__(cls, clsname, bases, attrs): 
     for field in RequiredFieldsMeta._interface: 
      if field not in attrs: 
       raise AttributeError(
        'Class %s missing required property %s' 
        % (clsname, field)) 
     for name in attrs: 
      if not isdunder(name) and name not in RequiredFieldsMeta._interface: 
       raise AttributeError(
        'Class %s has extra property %s' 
        % (clsname, name)) 
     return super(RequiredFieldsMeta, cls).__new__(cls, clsname, bases, attrs) 

# Works fine: 
class MongoCompany(metaclass=RequiredFieldsMeta): 
    company_name = 'Mongo Inc.' 
    num_employees = 100 

# Throws AttributeError: 
class ESyCompany(metaclass=RequiredFieldsMeta): 
    extra_prop = 'foobar' 

Here's一個快速演示

注意如何，我們甚至不使其向實例：類本身的定義時，我們的支票總是會自動運行。

編輯：在我的編輯中，我引用了一個函數is_dunder。這可以像name.startswith('__')或者正則表達式或者任何你想要的那樣簡單，只要它去掉python而不是程序員放在類中的屬性。

---

編輯2：只是爲了好玩，這裏有兩個，更 「優雅」 我們檢查的（儘管不那麼具體的）實現：

def __new__(cls, clsname, bases, attrs): 
    attr_names = {a for a in attrs if not is_dunder(a)} 

    if attr_names.difference(RequiredFieldsMeta._interface): 
     raise AttributeError('Class %s has extra properties' % clsname) 
    if RequiredFieldsMeta._interface.difference(attr_names): 
     raise AttributeError('Class %s missing required properties' % clsname) 

    return super(RequiredFieldsMeta, cls).__new__(cls, clsname, bases, attrs) 

或者乾脆：

def __new__(cls, clsname, bases, attrs): 
    attr_names = {a for a in attrs if not is_dunder(a)} 
    if attr_names != RequiredFieldsMeta._interface: 
     raise AttributeError(
      'Class %s does not match the required interface' % clsname) 
    return super(RequiredFieldsMeta, cls).__new__(cls, clsname, bases, attrs)