current community

your communities

more stack exchange communities

Stack Exchange
tour help
Take the 2-minute tour ×
Code Review Stack Exchange is a question and answer site for peer programmer code reviews. It's 100% free, no registration required.
up vote 0 down vote favorite

I was wondering what is the convention for return default types for python functions for e.g the below should Official return False or None, should Name return '' or None by default. What does Python recommend?

class Foo(object):

    def Official(self):
        """
        Flag to state if something is official e.g False / True
        :rtype: bool
        """
        return None

    def Name(self):
       """
       :rtype: str
       """
       return None
share|improve this question

closed as off-topic by jonrsharpe, syb0rg, Malachi, Donald.McLean, 200_success♦ May 25 at 6:14

This question appears to be off-topic. The users who voted to close gave this specific reason:

  • "Questions must involve real code that you own or maintain. Questions seeking an explanation of someone else's code are off-topic. Pseudocode, hypothetical code, or stub code should be replaced by a concrete example." – Malachi, Donald.McLean, 200_success
If this question can be reworded to fit the rules in the help center, please edit the question.
1  
Is this an abstract class, where subclasses are expected to override these methods? –  Anonymous May 24 at 19:28
1  
maybe ask python what it recommends, a question such as What does Python recommend? begs for an answer of did you google this? this doesn't even look like production code, please read the help section about On-Topic Questions specifically Is it actual code from a project rather than pseudo-code or example code? –  Malachi May 25 at 4:11
add comment

2 Answers

up vote 3 down vote

If those methods are supposed to be implemented in sub-classes inheriting from Foo, they should simply:

raise NotImplementedError

From the documentation:

In user defined base classes, abstract methods should raise [NotImplementedError] when they require derived classes to override the method.

share|improve this answer
add comment
up vote 1 down vote

I'm not aware of any language level conventions about this (which doesn't mean they don't exist, but I'd be surprised).

I think it's kind of impossible to make strong recommendations about your Foo class without knowing more of its context. Even with more context though, I think these sorts of questions often boil down to judgement and personal taste. And project-level conventions. If I was implementing your Foo, I'd probably have official return True/False and name return an empty string -- the empty string at least provides information about the type expected.

share|improve this answer
    
Cool thanks for the response I got a feeling your right its all about judgement and personal taste. Just trying to persist some consistency is probably the most important part –  user1741339 May 24 at 19:31
add comment

Not the answer you're looking for? Browse other questions tagged or ask your own question.