mypy and django models: how to detect errors on nonexistent attributes











up vote
2
down vote

favorite












Consider this model definition and usage:



from django.db import models


class User(models.Model):

name: str = models.CharField(max_length=100)


def do_stuff(user: User) -> None:

# accessing existing field
print(user.name.strip())

# accessing existing field with a wrong operation: will fail at runtime
print(user.name + 1)

# acessing nonexistent field: will fail at runtime
print(user.name_abc.strip())


While running mypy on this, we will get an error for user.name + 1:



error: Unsupported operand types for + ("str" and "int")


This is fine. But there's another error in the code - user.name_abc does not exist and will result in AttributeError in runtime.



However, mypy will not see this because it lets the code access any django attributes, also treating them as Any:



u = User(name='abc')
reveal_type(user.abcdef)
....

> error: Revealed type is 'Any


So, how do I make mypy see such errors?










share|improve this question






















  • It seems that this is related to the Django model class, not yours. If you are not subclassing Django model you get an error: stackoverflow.com/questions/50889677/…
    – danielfranca
    19 hours ago










  • @danielfranca exactly. This is related to django models. The question is - how do I work around it.
    – kurtgn
    18 hours ago















up vote
2
down vote

favorite












Consider this model definition and usage:



from django.db import models


class User(models.Model):

name: str = models.CharField(max_length=100)


def do_stuff(user: User) -> None:

# accessing existing field
print(user.name.strip())

# accessing existing field with a wrong operation: will fail at runtime
print(user.name + 1)

# acessing nonexistent field: will fail at runtime
print(user.name_abc.strip())


While running mypy on this, we will get an error for user.name + 1:



error: Unsupported operand types for + ("str" and "int")


This is fine. But there's another error in the code - user.name_abc does not exist and will result in AttributeError in runtime.



However, mypy will not see this because it lets the code access any django attributes, also treating them as Any:



u = User(name='abc')
reveal_type(user.abcdef)
....

> error: Revealed type is 'Any


So, how do I make mypy see such errors?










share|improve this question






















  • It seems that this is related to the Django model class, not yours. If you are not subclassing Django model you get an error: stackoverflow.com/questions/50889677/…
    – danielfranca
    19 hours ago










  • @danielfranca exactly. This is related to django models. The question is - how do I work around it.
    – kurtgn
    18 hours ago













up vote
2
down vote

favorite









up vote
2
down vote

favorite











Consider this model definition and usage:



from django.db import models


class User(models.Model):

name: str = models.CharField(max_length=100)


def do_stuff(user: User) -> None:

# accessing existing field
print(user.name.strip())

# accessing existing field with a wrong operation: will fail at runtime
print(user.name + 1)

# acessing nonexistent field: will fail at runtime
print(user.name_abc.strip())


While running mypy on this, we will get an error for user.name + 1:



error: Unsupported operand types for + ("str" and "int")


This is fine. But there's another error in the code - user.name_abc does not exist and will result in AttributeError in runtime.



However, mypy will not see this because it lets the code access any django attributes, also treating them as Any:



u = User(name='abc')
reveal_type(user.abcdef)
....

> error: Revealed type is 'Any


So, how do I make mypy see such errors?










share|improve this question













Consider this model definition and usage:



from django.db import models


class User(models.Model):

name: str = models.CharField(max_length=100)


def do_stuff(user: User) -> None:

# accessing existing field
print(user.name.strip())

# accessing existing field with a wrong operation: will fail at runtime
print(user.name + 1)

# acessing nonexistent field: will fail at runtime
print(user.name_abc.strip())


While running mypy on this, we will get an error for user.name + 1:



error: Unsupported operand types for + ("str" and "int")


This is fine. But there's another error in the code - user.name_abc does not exist and will result in AttributeError in runtime.



However, mypy will not see this because it lets the code access any django attributes, also treating them as Any:



u = User(name='abc')
reveal_type(user.abcdef)
....

> error: Revealed type is 'Any


So, how do I make mypy see such errors?







django mypy






share|improve this question













share|improve this question











share|improve this question




share|improve this question










asked 21 hours ago









kurtgn

1,67721938




1,67721938












  • It seems that this is related to the Django model class, not yours. If you are not subclassing Django model you get an error: stackoverflow.com/questions/50889677/…
    – danielfranca
    19 hours ago










  • @danielfranca exactly. This is related to django models. The question is - how do I work around it.
    – kurtgn
    18 hours ago


















  • It seems that this is related to the Django model class, not yours. If you are not subclassing Django model you get an error: stackoverflow.com/questions/50889677/…
    – danielfranca
    19 hours ago










  • @danielfranca exactly. This is related to django models. The question is - how do I work around it.
    – kurtgn
    18 hours ago
















It seems that this is related to the Django model class, not yours. If you are not subclassing Django model you get an error: stackoverflow.com/questions/50889677/…
– danielfranca
19 hours ago




It seems that this is related to the Django model class, not yours. If you are not subclassing Django model you get an error: stackoverflow.com/questions/50889677/…
– danielfranca
19 hours ago












@danielfranca exactly. This is related to django models. The question is - how do I work around it.
– kurtgn
18 hours ago




@danielfranca exactly. This is related to django models. The question is - how do I work around it.
– kurtgn
18 hours ago

















active

oldest

votes











Your Answer






StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");

StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});

function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});


}
});














 

draft saved


draft discarded


















StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53370377%2fmypy-and-django-models-how-to-detect-errors-on-nonexistent-attributes%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown






























active

oldest

votes













active

oldest

votes









active

oldest

votes






active

oldest

votes
















 

draft saved


draft discarded



















































 


draft saved


draft discarded














StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53370377%2fmypy-and-django-models-how-to-detect-errors-on-nonexistent-attributes%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown





















































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown

































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown







Popular posts from this blog

Wiesbaden

Marschland

Dieringhausen