CODEWITHSUNDEEP
pythonfunctionsyntax-error
Wolf
Wolf

Reputation: 10238

Is it possible to def a function with a dotted name in Python?

In the question What does the "yield" keyword do?, I found a Python syntax being used that I didn't expect to be valid. The question is old and has a huge number of votes, so I'm surprised nobody at least left a comment about this function definition:

def node._get_child_candidates(self, distance, min_dist, max_dist):
    if self._leftchild and distance - max_dist < self._median:
       yield self._leftchild
    if self._rightchild and distance + max_dist >= self._median:
       yield self._rightchild

What I tried to get this sort of syntax evaluated:

fails so far with

SyntaxError: invalid syntax

I looked up the link (maybe outdated) given in the question, and searched the web for the usage of def, but I found nothing explaining this "dotted name" pattern. I'm using Python 3, maybe this is a feature of Python 2?

Is (or was) this syntax valid, if yes what does it mean?

Upvotes: 9

Views: 492

Answers (2)

Padraic Cunningham
Padraic Cunningham

Reputation: 180481

As in my comment you cannot, the valid identifiers for python3 are in the docs:

Identifiers (also referred to as names) are described by the following lexical definitions.

The syntax of identifiers in Python is based on the Unicode standard annex UAX-31, with elaboration and changes as defined below; see also PEP 3131 for further details.

Within the ASCII range (U+0001..U+007F), the valid characters for identifiers are the same as in Python 2.x: the uppercase and lowercase letters A through Z, the underscore _ and, except for the first character, the digits 0 through 9.

Python 3.0 introduces additional characters from outside the ASCII range (see PEP 3131). For these characters, the classification uses the version of the Unicode Character Database as included in the unicodedata module.

If you examine the code you can see it is a typo in the original question:

def node._get_child_candidates(self, distance, min_dist, max_dist):
    if self._leftchild and distance - max_dist < self._median:
        yield self._leftchild
    if self._rightchild and distance + max_dist >= self._median:
        yield self._rightchild

And this is the caller:

result, candidates = list(), [self]
while candidates:
    node = candidates.pop() # creates an instance
    distance = node._get_dist(obj)
    if distance <= max_dist and distance >= min_dist:
        result.extend(node._values)
    # the _get_child_candidates node is called 
    candidates.extend(node._get_child_candidates(distance, min_dist, max_dist))
return result

So the method _get_child_candidates is called on the instance. So really the actual code looks like:

def _get_child_candidates(self, distance, min_dist, max_dist):
    if self._leftchild and distance - max_dist < self._median:
        yield self._leftchild
    if self._rightchild and distance + max_dist >= self._median:
        yield self._rightchild

And this is the caller:

result, candidates = list(), [self]
while candidates:
    node = candidates.pop() # creates an instance
    distance = node._get_dist(obj)
    if distance <= max_dist and distance >= min_dist:
        result.extend(node._values)
    # the _get_child_candidates node is called 
    candidates.extend(node._get_child_candidates(distance, min_dist, max_dist))
return result

Upvotes: 3

Zaur Nasibov
Zaur Nasibov

Reputation: 22659

No, the syntax is not valid. It is easy to prove by checking the documentation. In Python 2, an identifier is constructed by the following rules:

identifier ::=  (letter|"_") (letter | digit | "_")*
letter     ::=  lowercase | uppercase
lowercase  ::=  "a"..."z"
uppercase  ::=  "A"..."Z"
digit      ::=  "0"..."9"

In Py3 the rules are more or less the same, beside being expanded up to the range of Unicode characters.

It seems that the author probably meant something like

class Node:
    ...
    def _get_child_candidates(self, ...):
        ...

Upvotes: 4

Related Questions