Table of Contents
The dir() method tries to return a list of valid attributes of the object.
The syntax of dir() is:
dir([object])
1. dir() Parameters
dir() takes maximum of one object.
- object (optional) –
dir()attempts to return all attributes of this object.
2. Return Value from dir()
dir() tries to return a list of valid attributes of the object.
- If the object has
__dir__()method, the method will be called and must return the list of attributes. - If the object doesn’t have
__dir__()method, this method tries to find information from the__dict__attribute (if defined), and from type object. In this case, the list returned fromdir()may not be complete.
If an object is not passed to dir() method, it returns the list of names in the current local scope.
3. Example 1: How dir() works?
number = [1, 2, 3]
print(dir(number))
print('\nReturn Value from empty dir()')
print(dir())
Output
['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__gt__', '__hash__', '__iadd__', '__imul__', '__init__', '__init_subclass__', '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__', '__sizeof__', '__str__', '__subclasshook__', 'append', 'clear', 'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort'] Return Value from empty dir() ['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'number']
4. Example 2: dir() on User-defined Object
class Person:
def __dir__(self):
return ['age', 'name', 'salary']
teacher = Person()
print(dir(teacher))
Output
['age', 'name', 'salary']
Related posts:
How to get current date and time in Python?
Python datetime
Python Program to Print Hello world!
Python iter()
Python File I/O Operation
Python sorted()
Python List pop()
Python Program to Check if a Number is Positive, Negative or 0
Python getattr()
Python Program to Convert Bytes to a String
Python Decorators
Python Program to Append to a File
Python Errors and Built-in Exceptions
Python Data Structures and Algorithms - Benjamin Baka
Python Type Conversion and Type Casting
Python Program to Return Multiple Values From a Function
Python Statement, Indentation and Comments
Python open()
Python String isprintable()
Python Machine Learning Third Edition - Sebastian Raschka & Vahid Mirjalili
Python Program to Differentiate Between del, remove, and pop on a List
Python float()
Python Program to Get Line Count of a File
Python List extend()
Python Tuple
Python bytearray()
Python Program to Get the Class Name of an Instance
Python Program to Randomly Select an Element From the List
Python Deep Learning Cookbook - Indra den Bakker
Python Program to Remove Punctuations From a String
Python String translate()
Python Iterators