Trong Python, làm cách nào để cho biết tôi đang ghi đè phương thức?

Question

Trong Java, ví dụ, chú thích @Override không chỉ cung cấp việc kiểm tra thời gian biên dịch ghi đè mà còn tạo ra mã tự tạo tài liệu tuyệt vời. Tôi chỉ đang tìm tài liệu (mặc dù nếu đó là chỉ báo cho một số người kiểm tra như pylint, đó là phần thưởng). Tôi có thể thêm một bình luận hoặc docstring một nơi nào đó, nhưng cách thành ngữ để chỉ ra một ghi đè trong Python là gì?

Answer 1

UPDATE (2015/05/23): Dựa vào điều này và fwc: s câu trả lời tôi đã tạo ra một pip có thể cài đặt gói https://github.com/mkorpela/overrides

Từ bất cứ lúc nào tôi kết thúc ở đây nhìn vào câu hỏi này. Chủ yếu điều này xảy ra sau (một lần nữa) thấy cùng một lỗi trong cơ sở mã của chúng tôi: Ai đó đã quên một số lớp "giao diện" triển khai thực hiện trong khi đổi tên một phương thức trong "giao diện" ..

Vâng Python không phải là Java nhưng Python có quyền lực - và rõ ràng là tốt hơn là tiềm ẩn - và có những trường hợp cụ thể thực sự trong thế giới thực, nơi điều này sẽ giúp tôi.

Vì vậy, đây là bản phác thảo ghi đè trang trí. Điều này sẽ kiểm tra xem lớp được đưa ra như một tham số có cùng một phương thức (hay cái gì đó) tên như là phương thức được trang trí.

Nếu bạn có thể nghĩ ra giải pháp tốt hơn, hãy đăng nó ở đây!

def overrides(interface_class): 
    def overrider(method): 
     assert(method.__name__ in dir(interface_class)) 
     return method 
    return overrider 

Nó hoạt động như sau:

class MySuperInterface(object): 
    def my_method(self): 
     print 'hello world!' 


class ConcreteImplementer(MySuperInterface): 
    @overrides(MySuperInterface) 
    def my_method(self): 
     print 'hello kitty!' 

và nếu bạn làm một phiên bản bị lỗi nó sẽ nâng cao một lỗi khẳng định trong lớp tải:

class ConcreteFaultyImplementer(MySuperInterface): 
    @overrides(MySuperInterface) 
    def your_method(self): 
     print 'bye bye!' 

>> AssertionError!!!!!!! 

Answer 2

Theo như tôi biết, không có cách nào đặc biệt để chỉ ra ghi đè bằng Python. Bạn chỉ cần xác định phương thức và bao gồm một docstring, như mọi khi.

Answer 3

Python không phải là Java. Tất nhiên là không có thứ gì như kiểm tra thời gian biên dịch.

Tôi nghĩ rằng nhận xét trong chuỗi tài liệu rất nhiều. Điều này cho phép bất kỳ người dùng nào của phương thức của bạn nhập help(obj.method) và thấy rằng phương thức này là ghi đè.

Bạn cũng có thể mở rộng giao diện một cách rõ ràng với class Foo(Interface), cho phép người dùng nhập help(Interface.method) để có ý tưởng về chức năng mà phương pháp của bạn nhằm cung cấp.

Answer 4

Nếu bạn muốn điều này cho các mục đích tài liệu duy nhất, bạn có thể xác định override trang trí của riêng bạn:

def override(f): 
    return f 


class MyClass (BaseClass): 

    @override 
    def method(self): 
     pass 

Đây thực sự là không có gì nhưng eye-candy, trừ khi bạn tạo ghi đè (f) theo cách như vậy đó là thực sự kiểm tra ghi đè.

Nhưng sau đó, đây là Python, tại sao viết nó giống như Java?

Answer 5

Dưới đây là một thực hiện điều đó không có yêu cầu đặc tả của tên interface_class.

import inspect 
import re 

def overrides(method): 
    # actually can't do this because a method is really just a function while inside a class def'n 
    #assert(inspect.ismethod(method)) 

    stack = inspect.stack() 
    base_classes = re.search(r'class.+\((.+)\)\s*\:', stack[2][4][0]).group(1) 

    # handle multiple inheritance 
    base_classes = [s.strip() for s in base_classes.split(',')] 
    if not base_classes: 
     raise ValueError('overrides decorator: unable to determine base class') 

    # stack[0]=overrides, stack[1]=inside class def'n, stack[2]=outside class def'n 
    derived_class_locals = stack[2][0].f_locals 

    # replace each class name in base_classes with the actual class type 
    for i, base_class in enumerate(base_classes): 

     if '.' not in base_class: 
      base_classes[i] = derived_class_locals[base_class] 

     else: 
      components = base_class.split('.') 

      # obj is either a module or a class 
      obj = derived_class_locals[components[0]] 

      for c in components[1:]: 
       assert(inspect.ismodule(obj) or inspect.isclass(obj)) 
       obj = getattr(obj, c) 

      base_classes[i] = obj 


    assert(any(hasattr(cls, method.__name__) for cls in base_classes)) 
    return method 

Answer 6

Giống như những người khác đã nói không giống như Java không có thẻ @Overide tuy nhiên ở trên, bạn có thể tạo ra bằng cách sử dụng trang trí riêng tuy nhiên tôi sẽ đề nghị sử dụng getattrib() phương pháp toàn cầu thay vì sử dụng dict nội bộ để bạn có được một cái gì đó như như sau:

def Override(superClass): 
    def method(func) 
     getattr(superClass,method.__name__) 
    return method 

Nếu bạn muốn bạn có thể bắt getattr(), hãy thử bắt lỗi của riêng bạn nhưng tôi nghĩ phương pháp getattr tốt hơn trong trường hợp này.

Ngoài này bắt tất cả các mục bị ràng buộc vào một lớp học bao gồm các phương pháp lớp và vairables

Answer 7

Nghe là đơn giản nhất và làm việc theo Jython với các lớp Java:

class MyClass(SomeJavaClass): 
    def __init__(self): 
     setattr(self, "name_of_method_to_override", __method_override__) 

    def __method_override__(self, some_args): 
     some_thing_to_do()