Python variable and function annotation raises AttributeError

Question

Although variable current_timestamp (and thus also the function return value) and variable time are datetime.datetime class objects, the following code raises AttributeError: type object 'datetime.datetime' has no attribute 'datetime'

from datetime import datetime

def current_time() -> datetime.datetime:
   
    current_timestamp: datetime.datetime = datetime.now()
    return current_timestamp

time: datetime.datetime = current_time()
print(time)

Changing only the annotation for the function return value and the time variable solves the problem.

from datetime import datetime

def current_time() -> datetime:
   
    current_timestamp: datetime.datetime = datetime.now()
    return current_timestamp

time: datetime = current_time()
print(time)

Can anyone explain why the annotation datetime.datetime raises only an AttributeError for the function return value and the time variable, but not for the current_timestamp variable?

I am running Python 3.8.

Silvio Mayolo · Accepted Answer · 2021-04-11 19:06:57Z

5

From PEP 526, where this syntax is defined

Annotating a local variable will cause the interpreter to treat it as a local, even if it was never assigned to. Annotations for local variables will not be evaluated:
def f():
    x: NonexistentName  # No error.
However, if it is at a module or class level, then the type will be evaluated:
x: NonexistentName  # Error!
class X:
    var: NonexistentName  # Error!
In addition, at the module or class level, if the item being annotated is a simple name, then it and the annotation will be stored in the __annotations__ attribute of that module or class (mangled if private) as an ordered mapping from names to evaluated annotations.

So the reason is that annotations are meant to be a general-purpose tool, leaving open the possibility of using them for things other than type signatures. At the module or class level, you can get access to this information at runtime using reflection techniques, so the value has to exist and will be evaluated. When applied to a local variable, however, no reflection is available on local variables so the annotation is only useful to third-party tools parsing the code, hence Python itself has no reason to evaluate it.

It's worth noting that mypy will fail on the second example, and if you want to use an actual type checker you will have to correct the annotation in every place.

answered Apr 11, 2021 at 19:06

Silvio Mayolo

71k7 gold badges93 silver badges141 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

juanpa.arrivillaga Over a year ago

Although note, the behavior is changing. If you use from __future__ import annotations then all annotations will not be evaluated, and kept as strings. This becomes the default behavior in Python 3.10, I believe. I'm currently working with a code base that relied on the previous behavior, and it's going to be not fun updating it.

deepak mahapatra · Accepted Answer · 2021-04-11 19:06:08Z

-1

The answer lies in your implementation only.

When you are importing the datetime object from datetime you are expecting the function to return an object of type datetime from the datetime module.

The datetime module has many classes under it and one of that is datetime.

import datetime
def current_time() -> datetime.datetime:
    current_timestamp: datetime = datetime.datetime.now()
    return current_timestamp


time: datetime.datetime = current_time()
print(time)

The above implementation shows if you want to have the function annotation as you have stated in the first case. Hope this helps in understanding the correct import of datetime module.

answered Apr 11, 2021 at 19:06

deepak mahapatra

3254 silver badges10 bronze badges

2 Comments

Silvio Mayolo Over a year ago

I'm pretty sure that what he's asking about is specified by Python itself. In any case, I can reliably reproduce the results on my own Python 3.7 as well, so I doubt it's entirely a quirk of the implementation.

deepak mahapatra Over a year ago

ahh..!! got it now, I misinterpreted the question in the first place. Your explanation helped me understand.

Collectives™ on Stack Overflow

Python variable and function annotation raises AttributeError

2 Answers 2

1 Comment

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related