


How do I use the __len__ method to define the length of an object in Python?
Jun 29, 2025 am 01:57 AMTo customize the object length returned by the len() function in Python, implement the __len__ method in the class and make sure it returns a non-negative integer. 1. The __len__ method does not accept parameters other than self and is used to define the concept of "length" of the object; 2. If this method is not implemented, calling len() will throw a TypeError; 3. The return value must be an integer and should have practical significance, such as representing the number of elements in the container; 4. Commonly used in classes similar to container or sequence behavior, such as shopping carts, custom lists, etc.; 5. Returning non-integers or negative numbers will cause errors or do not comply with the specifications; 6. Performance and consistency should be considered during implementation to make the class more "Pythonic" style.
When you want to define what len()
should return for your custom object in Python, you implement the __len__
method. It's straightforward — just make sure it returns a non-negative integer.
How __len__
Works in a Custom Class
If you've created a class and want to use len(instance_of_your_class)
, you need to define __len__
inside that class. This method doesn't take any arguments except self
.
For example:
class MyCollection: def __init__(self, items): self.items = items def __len__(self): return len(self.items)
Now when you do this:
coll = MyCollection([1, 2, 3]) print(len(coll)) # Outputs: 3
It works because __len__
is returning the length of the internal list.
Keep in mind:
- If you don't define
__len__
, callinglen()
on an instance will raise aTypeError
. - The return value must be an integer and ideally should represent something meaningful about your object.
Common Use Cases and Examples
You'll often see __len__
used in classes that behave like containers or sequences. For example:
- A custom list wrapper
- A database query result that supports pagination
- A file reader that tracks how many lines are loaded
Here's another practical case: say you have a shopping cart class.
class ShoppingCart: def __init__(self): self.products = [] def add_product(self, product): self.products.append(product) def __len__(self): return len(self.products)
Now len(cart)
gives you the number of products added — very intuitive behavior.
This helps especially if you're writing code that other developers might use. Having len()
work as expected makes your class feel more "Pythonic".
What Happens If You Return Something Invalid?
The __len__
method must return an integer. If you return anything else — like a float, string, or even None
— Python will throw a TypeError
.
Try this:
def __len__(self): return 'not-an-int'
And then call len(obj)
— you'll get an error like:
TypeError: 'str' object cannot be interpreted as an integer
Also, if you return a negative number, Python won't stop you directly, but it's considered bad practice. Built-in types usually avoid that, so it's best not to surprise users of your class.
Tips for Implementing __len__
- Think about what “l(fā)ength” means for your object. Is it the number of items, characters, entries, or something else?
- Make sure it's consistent with how other container-like objects behave.
- Don't overcomplicate the logic unless necessary — keep performance in mind if computing length is expensive.
In short, implementing __len__
is simple, but choosing a logical and useful definition of length matters most.
Basically that's it.
The above is the detailed content of How do I use the __len__ method to define the length of an object in Python?. For more information, please follow other related articles on the PHP Chinese website!

Hot AI Tools

Undress AI Tool
Undress images for free

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Clothoff.io
AI clothes remover

Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

Polymorphism is a core concept in Python object-oriented programming, referring to "one interface, multiple implementations", allowing for unified processing of different types of objects. 1. Polymorphism is implemented through method rewriting. Subclasses can redefine parent class methods. For example, the spoke() method of Animal class has different implementations in Dog and Cat subclasses. 2. The practical uses of polymorphism include simplifying the code structure and enhancing scalability, such as calling the draw() method uniformly in the graphical drawing program, or handling the common behavior of different characters in game development. 3. Python implementation polymorphism needs to satisfy: the parent class defines a method, and the child class overrides the method, but does not require inheritance of the same parent class. As long as the object implements the same method, this is called the "duck type". 4. Things to note include the maintenance

Iterators are objects that implement __iter__() and __next__() methods. The generator is a simplified version of iterators, which automatically implement these methods through the yield keyword. 1. The iterator returns an element every time he calls next() and throws a StopIteration exception when there are no more elements. 2. The generator uses function definition to generate data on demand, saving memory and supporting infinite sequences. 3. Use iterators when processing existing sets, use a generator when dynamically generating big data or lazy evaluation, such as loading line by line when reading large files. Note: Iterable objects such as lists are not iterators. They need to be recreated after the iterator reaches its end, and the generator can only traverse it once.

The key to dealing with API authentication is to understand and use the authentication method correctly. 1. APIKey is the simplest authentication method, usually placed in the request header or URL parameters; 2. BasicAuth uses username and password for Base64 encoding transmission, which is suitable for internal systems; 3. OAuth2 needs to obtain the token first through client_id and client_secret, and then bring the BearerToken in the request header; 4. In order to deal with the token expiration, the token management class can be encapsulated and automatically refreshed the token; in short, selecting the appropriate method according to the document and safely storing the key information is the key.

A common method to traverse two lists simultaneously in Python is to use the zip() function, which will pair multiple lists in order and be the shortest; if the list length is inconsistent, you can use itertools.zip_longest() to be the longest and fill in the missing values; combined with enumerate(), you can get the index at the same time. 1.zip() is concise and practical, suitable for paired data iteration; 2.zip_longest() can fill in the default value when dealing with inconsistent lengths; 3.enumerate(zip()) can obtain indexes during traversal, meeting the needs of a variety of complex scenarios.

TypehintsinPythonsolvetheproblemofambiguityandpotentialbugsindynamicallytypedcodebyallowingdeveloperstospecifyexpectedtypes.Theyenhancereadability,enableearlybugdetection,andimprovetoolingsupport.Typehintsareaddedusingacolon(:)forvariablesandparamete

InPython,iteratorsareobjectsthatallowloopingthroughcollectionsbyimplementing__iter__()and__next__().1)Iteratorsworkviatheiteratorprotocol,using__iter__()toreturntheiteratorand__next__()toretrievethenextitemuntilStopIterationisraised.2)Aniterable(like

Assert is an assertion tool used in Python for debugging, and throws an AssertionError when the condition is not met. Its syntax is assert condition plus optional error information, which is suitable for internal logic verification such as parameter checking, status confirmation, etc., but cannot be used for security or user input checking, and should be used in conjunction with clear prompt information. It is only available for auxiliary debugging in the development stage rather than substituting exception handling.

To create modern and efficient APIs using Python, FastAPI is recommended; it is based on standard Python type prompts and can automatically generate documents, with excellent performance. After installing FastAPI and ASGI server uvicorn, you can write interface code. By defining routes, writing processing functions, and returning data, APIs can be quickly built. FastAPI supports a variety of HTTP methods and provides automatically generated SwaggerUI and ReDoc documentation systems. URL parameters can be captured through path definition, while query parameters can be implemented by setting default values ??for function parameters. The rational use of Pydantic models can help improve development efficiency and accuracy.
