Python introspection: How to get an 'unsorted' list of object attributes?

Question

The following code

import types
class A:
    class D:
        pass
    class C:
        pass
for d in dir(A):
    if type(eval('A.'+d)) is types.ClassType:
        print d

outputs

C
D

How do I get it to output in the order in which these classes were defined in the code? I.e.

D
C

Is there any way other than using inspect.getsource(A) and parsing that?

django's forms and model declarations attempt to go by the order in which the entries were made. The attributes however are instances as opposed to class declarations. I'm trying to figure out if class declarations can be so ordered as this would help in auto-template generation. — molicule, Mar 12 '09 at 22:13
For a odd question like this it's probably better to explain why you want to do what you're trying to do and add a django tag. — David Locke, Mar 12 '09 at 22:15

score 8 · Answer 1 · answered Mar 12 '09 at 21:51

Note that that parsing is already done for you in inspect - take a look at inspect.findsource, which searches the module for the class definition and returns the source and line number. Sorting on that line number (you may also need to split out classes defined in separate modules) should give the right order.

However, this function doesn't seem to be documented, and is just using a regular expression to find the line, so it may not be too reliable.

Another option is to use metaclasses, or some other way to either implicitly or explicitly ordering information to the object. For example:

import itertools, operator

next_id = itertools.count().next

class OrderedMeta(type):
    def __init__(cls, name, bases, dct):
        super(OrderedMeta, cls).__init__(name, bases, dct)
        cls._order = next_id()

# Set the default metaclass
__metaclass__ = OrderedMeta

class A:
    class D:
        pass
    class C:
        pass

print sorted([cls for cls in [getattr(A, name) for name in dir(A)] 
           if isinstance(cls, OrderedMeta)], key=operator.attrgetter("_order"))

However this is a fairly intrusive change (requires setting the metaclass of any classes you're interested in to OrderedMeta)

I liked this approach, but I went with using inspect.findsource and chose MizardX's answer — molicule, Mar 12 '09 at 22:43

score 5 · Answer 2 · answered Mar 12 '09 at 21:14

5

No, you can't get those attributes in the order you're looking for. Python attributes are stored in a dict (read: hashmap), which has no awareness of insertion order.

Also, I would avoid the use of eval by simply saying

if type(getattr(A, d)) is types.ClassType:
    print d

in your loop. Note that you can also just iterate through key/value pairs in A.__dict__

answered Mar 12 '09 at 21:14

zweiterlinde

14,557
2
27
32

1

Yea, +1 for using getattr instead of eval. – David Wolever Mar 12 '09 at 21:15

score 5 · Accepted Answer · answered Mar 12 '09 at 22:03

The inspect module also has the findsource function. It returns a tuple of source lines and line number where the object is defined.

>>> import inspect
>>> import StringIO
>>> inspect.findsource(StringIO.StringIO)[1]
41
>>>

The findsource function actually searches trough the source file and looks for likely candidates if it is given a class-object.

Given a method-, function-, traceback-, frame-, or code-object, it simply looks at the co_firstlineno attribute of the (contained) code-object.

You may also use the `getsourcelines` function, which returns only the object's source lines and the starting line number in a tuple. — Andreas Kraft, Dec 09 '22 at 22:20

score 1 · Answer 4 · answered Mar 12 '09 at 21:13

AFAIK, no -- there isn't*. This is because all of a class's attributes are stored in a dictionary (which is, as you know, unordered).

*: it might actually be possible, but that would require either decorators or possibly metaclass hacking. Do either of those interest you?

Daniel Brenot · Answer 5 · 2022-01-10T17:38:01.140

class ExampleObject:
    def example2():
        pass
    
    def example1():
        pass

context = ExampleObject

def sort_key(item):
    return inspect.findsource(item)[1]

properties = [
    getattr(context, attribute) for attribute in dir(context)
    if callable(getattr(context, attribute)) and 
    attribute.startswith('__') is False
]
properties.sort(key=sort_key)

print(properties)

Should print out:

[<function ExampleObject.example2 at 0x7fc2baf9e940>, <function ExampleObject.example1 at 0x7fc2bae5e790>]

I needed to use this as well for some compiler i'm building, and this proved very useful.

score 0 · Answer 6 · answered Mar 12 '09 at 21:33

0

I'm not trying to be glib here, but would it be feasible for you to organize the classes in your source alphabetically? i find that when there are lots of classes in one file this can be useful in its own right.

answered Mar 12 '09 at 21:33

Atilio Jobson

719
1
8
11

Python introspection: How to get an 'unsorted' list of object attributes?

6 Answers6