python内置函数3-dir()

Help on built-in function dir in module __builtin__:

dir(...)

    dir([object]) -> list of strings

    If called without an argument, return the names in the current scope.

    Else, return an alphabetized list of names comprising (some of) the attributes

    of the given object, and of attributes reachable from it.

    If the object supplies a method named __dir__, it will be used; otherwise

    the default dir() logic is used and returns:

      for a module object: the module's attributes.

      for a class object:  its attributes, and recursively the attributes

        of its bases.

      for any other object: its attributes, its class's attributes, and

        recursively the attributes of its class's base classes.

dir([object])

Without arguments, return the list of names in the current local scope. With an argument, attempt to return a list of valid attributes for that object.

If the object has a method named __dir__(), this method will be called and must return the list of attributes. This allows objects that implement a custom __getattr__() or __getattribute__() function to customize the way dir() reports their attributes.

If the object does not provide __dir__(), the function tries its best to gather infORMation from the object’s __dict__ attribute, if defined, and from its type object. The resulting list is not necessarily complete, and may be inaccurate when the object has a custom __getattr__().

The default dir() mechanism behaves differently with different types of objects, as it attempts to produce the most relevant, rather than complete, information:

If the object is a module object, the list contains the names of the module’s attributes.

If the object is a type or class object, the list contains the names of its attributes, and recursively of the attributes of its bases.

Otherwise, the list contains the object’s attributes’ names, the names of its class’s attributes, and recursively of the attributes of its class’s base classes.

The resulting list is sorted alphabetically. For example:

>>>

>>> import struct

>>> dir()   # show the names in the module namespace

['__builtins__', '__doc__', '__name__', 'struct']

>>> dir(struct)   # show the names in the struct module

['Struct', '__builtins__', '__doc__', '__file__', '__name__',

 '__package__', '_clearcache', 'calcsize', 'error', 'pack', 'pack_into',

 'unpack', 'unpack_from']

>>> class Shape(object):

        def __dir__(self):

            return ['area', 'perimeter', 'location']

>>> s = Shape()

>>> dir(s)

['area', 'perimeter', 'location']

Note Because dir() is supplied primarily as a convenience for use at an interactive prompt, it tries to supply an interesting set of names more than it tries to supply a riGorously or consistently defined set of names, and its detailed behavior may change across releases. For example, metaclass attributes are not in the result list when the argument is a class.

中文说明：不带参数时，返回当前范围内的变量、方法和定义的类型列表；带参数时，返回参数的属性、方法列表。如果参数包含方法__dir__()，该方法将被调用。如果参数不包含__dir__()，该方法将最大限度地收集参数信息。

参数object： 对象、变量、类型。

>>> dir()

['Person', '__builtins__', '__doc__', '__name__', '__package__', 'a', 'cmpcode', 'code', 'i', 'str', 'tom']

>>> import struct

>>> dir()

['Person', '__builtins__', '__doc__', '__name__', '__package__', 'a', 'cmpcode', 'code', 'i', 'str', 'struct', 'tom']

>>> dir(struct)

['Struct', '__builtins__', '__doc__', '__file__', '__name__', '__package__', '_clearcache', 'calcsize', 'error', 'pack', 'pack_into', 'unpack', 'unpack_from']

>>> class Person(object):

...     def __dir__(self):

...             return ["name", "age", "country"]

... 

>>> dir(Person)

['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__format__', '__getattribute__', '__hash__', '__init__', '__module__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__']

>>> tom=Person()

>>> dir(tom)

['age', 'country', 'name']