Move 'todo's out of generated code

codegen/JsonDescriptionOfGithubApiV3/normalize.py

@@ -4,6 +4,9 @@ import os.path
 import json
 import itertools
 
+### @todo Mandatory/optional attributes
+### @todo Remove '_identity' from the normalized json description
+
 def checkKeys( d, mandatoryKeys, optionalKeys = [] ):
     assert set( d.keys() ) >= set( mandatoryKeys ), d.keys()
     assert set( d.keys() ) <= set( mandatoryKeys ) | set( optionalKeys ) | set( [ "@todo" ] ), d.keys()

codegen/templates/GithubObject.py

@@ -36,7 +36,6 @@ class {{ class.name }}( object ):
 {% endfor %}
 
 {% if class.identity %}
-    # @todo Remove '_identity' from the normalized json description
     @property
     def _identity( self ):
         return {% include "GithubObject.Concatenation.py" with concatenation=class.identity only  %}
@@ -64,7 +63,6 @@ class {{ class.name }}( object ):
 {% endif %}
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
 {% for attribute in class.attributes|dictsort:"name" %}
         if "{{ attribute.name }}" in attributes and attributes[ "{{ attribute.name }}" ] is not None: # pragma no branch
 

src/github/AuthenticatedUser.py

@@ -564,7 +564,6 @@ class AuthenticatedUser( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "avatar_url" in attributes and attributes[ "avatar_url" ] is not None: # pragma no branch
             assert isinstance( attributes[ "avatar_url" ], ( str, unicode ) )
             self.__avatar_url = attributes[ "avatar_url" ]

src/github/Authorization.py

@@ -113,7 +113,6 @@ class Authorization( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "app" in attributes and attributes[ "app" ] is not None: # pragma no branch
             self.__app = attributes[ "app" ]
         if "created_at" in attributes and attributes[ "created_at" ] is not None: # pragma no branch

src/github/Branch.py

@@ -24,7 +24,6 @@ class Branch( object ):
         self.__name = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "commit" in attributes and attributes[ "commit" ] is not None: # pragma no branch
             assert isinstance( attributes[ "commit" ], dict )
             self.__commit = Commit.Commit( self.__requester, attributes[ "commit" ], completion = LazyCompletion )

src/github/Commit.py

@@ -116,7 +116,6 @@ class Commit( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "author" in attributes and attributes[ "author" ] is not None: # pragma no branch
             assert isinstance( attributes[ "author" ], dict )
             self.__author = NamedUser.NamedUser( self.__requester, attributes[ "author" ], completion = LazyCompletion )

src/github/CommitComment.py

@@ -117,7 +117,6 @@ class CommitComment( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "body" in attributes and attributes[ "body" ] is not None: # pragma no branch
             assert isinstance( attributes[ "body" ], ( str, unicode ) )
             self.__body = attributes[ "body" ]

src/github/CommitFile.py

@@ -58,7 +58,6 @@ class CommitFile( object ):
         self.__status = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "additions" in attributes and attributes[ "additions" ] is not None: # pragma no branch
             self.__additions = attributes[ "additions" ]
         if "blob_url" in attributes and attributes[ "blob_url" ] is not None: # pragma no branch

src/github/CommitStats.py

@@ -28,7 +28,6 @@ class CommitStats( object ):
         self.__total = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "additions" in attributes and attributes[ "additions" ] is not None: # pragma no branch
             assert isinstance( attributes[ "additions" ], int )
             self.__additions = attributes[ "additions" ]

src/github/Download.py

@@ -158,7 +158,6 @@ class Download( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "accesskeyid" in attributes and attributes[ "accesskeyid" ] is not None: # pragma no branch
             self.__accesskeyid = attributes[ "accesskeyid" ]
         if "acl" in attributes and attributes[ "acl" ] is not None: # pragma no branch

src/github/Event.py

@@ -56,7 +56,6 @@ class Event( object ):
         self.__type = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "actor" in attributes and attributes[ "actor" ] is not None: # pragma no branch
             assert isinstance( attributes[ "actor" ], dict )
             self.__actor = NamedUser.NamedUser( self.__requester, attributes[ "actor" ], completion = LazyCompletion )

src/github/Gist.py

@@ -216,7 +216,6 @@ class Gist( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "comments" in attributes and attributes[ "comments" ] is not None: # pragma no branch
             assert isinstance( attributes[ "comments" ], int )
             self.__comments = attributes[ "comments" ]

src/github/GistComment.py

@@ -64,7 +64,6 @@ class GistComment( object ):
         self.__user = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "body" in attributes and attributes[ "body" ] is not None: # pragma no branch
             self.__body = attributes[ "body" ]
         if "created_at" in attributes and attributes[ "created_at" ] is not None: # pragma no branch

src/github/GistHistoryState.py

@@ -40,7 +40,6 @@ class GistHistoryState( object ):
         self.__version = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "change_status" in attributes and attributes[ "change_status" ] is not None: # pragma no branch
             assert isinstance( attributes[ "change_status" ], dict )
             self.__change_status = CommitStats.CommitStats( self.__requester, attributes[ "change_status" ], completion = LazyCompletion )

src/github/GitAuthor.py

@@ -28,7 +28,6 @@ class GitAuthor( object ):
         self.__name = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "date" in attributes and attributes[ "date" ] is not None: # pragma no branch
             assert isinstance( attributes[ "date" ], ( str, unicode ) )
             self.__date = attributes[ "date" ]

src/github/GitBlob.py

@@ -38,7 +38,6 @@ class GitBlob( object ):
         self.__url = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "content" in attributes and attributes[ "content" ] is not None: # pragma no branch
             assert isinstance( attributes[ "content" ], ( str, unicode ) )
             self.__content = attributes[ "content" ]

src/github/GitCommit.py

@@ -51,7 +51,6 @@ class GitCommit( object ):
         self.__url = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "author" in attributes and attributes[ "author" ] is not None: # pragma no branch
             assert isinstance( attributes[ "author" ], dict )
             self.__author = GitAuthor.GitAuthor( self.__requester, attributes[ "author" ], completion = LazyCompletion )

src/github/GitObject.py

@@ -28,7 +28,6 @@ class GitObject( object ):
         self.__url = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "sha" in attributes and attributes[ "sha" ] is not None: # pragma no branch
             assert isinstance( attributes[ "sha" ], ( str, unicode ) )
             self.__sha = attributes[ "sha" ]

src/github/GitRef.py

@@ -51,7 +51,6 @@ class GitRef( object ):
         self.__url = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "object" in attributes and attributes[ "object" ] is not None: # pragma no branch
             assert isinstance( attributes[ "object" ], dict )
             self.__object = GitObject.GitObject( self.__requester, attributes[ "object" ], completion = LazyCompletion )

src/github/GitTag.py

@@ -45,7 +45,6 @@ class GitTag( object ):
         self.__url = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "message" in attributes and attributes[ "message" ] is not None: # pragma no branch
             assert isinstance( attributes[ "message" ], ( str, unicode ) )
             self.__message = attributes[ "message" ]

src/github/GitTree.py

@@ -29,7 +29,6 @@ class GitTree( object ):
         self.__url = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "sha" in attributes and attributes[ "sha" ] is not None: # pragma no branch
             assert isinstance( attributes[ "sha" ], ( str, unicode ) )
             self.__sha = attributes[ "sha" ]

src/github/GitTreeElement.py

@@ -43,7 +43,6 @@ class GitTreeElement( object ):
         self.__url = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "mode" in attributes and attributes[ "mode" ] is not None: # pragma no branch
             assert isinstance( attributes[ "mode" ], ( str, unicode ) )
             self.__mode = attributes[ "mode" ]

src/github/Hook.py

@@ -95,7 +95,6 @@ class Hook( object ):
         self.__url = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "active" in attributes and attributes[ "active" ] is not None: # pragma no branch
             self.__active = attributes[ "active" ]
         if "config" in attributes and attributes[ "config" ] is not None: # pragma no branch

src/github/Issue.py

@@ -264,7 +264,6 @@ class Issue( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "assignee" in attributes and attributes[ "assignee" ] is not None: # pragma no branch
             assert isinstance( attributes[ "assignee" ], dict )
             self.__assignee = NamedUser.NamedUser( self.__requester, attributes[ "assignee" ], completion = LazyCompletion )

src/github/IssueComment.py

@@ -64,7 +64,6 @@ class IssueComment( object ):
         self.__user = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "body" in attributes and attributes[ "body" ] is not None: # pragma no branch
             self.__body = attributes[ "body" ]
         if "created_at" in attributes and attributes[ "created_at" ] is not None: # pragma no branch

src/github/IssueEvent.py

@@ -74,7 +74,6 @@ class IssueEvent( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "actor" in attributes and attributes[ "actor" ] is not None: # pragma no branch
             assert isinstance( attributes[ "actor" ], dict )
             self.__actor = NamedUser.NamedUser( self.__requester, attributes[ "actor" ], completion = LazyCompletion )

src/github/Milestone.py

@@ -110,7 +110,6 @@ class Milestone( object ):
         self.__url = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "closed_issues" in attributes and attributes[ "closed_issues" ] is not None: # pragma no branch
             assert isinstance( attributes[ "closed_issues" ], int )
             self.__closed_issues = attributes[ "closed_issues" ]

src/github/NamedUser.py

@@ -313,7 +313,6 @@ class NamedUser( object ):
             data
         )
 
-    # @todo Remove '_identity' from the normalized json description
     @property
     def _identity( self ):
         return str( self.login )
@@ -361,7 +360,6 @@ class NamedUser( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "avatar_url" in attributes and attributes[ "avatar_url" ] is not None: # pragma no branch
             assert isinstance( attributes[ "avatar_url" ], ( str, unicode ) )
             self.__avatar_url = attributes[ "avatar_url" ]

src/github/Organization.py

@@ -386,7 +386,6 @@ class Organization( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "avatar_url" in attributes and attributes[ "avatar_url" ] is not None: # pragma no branch
             assert isinstance( attributes[ "avatar_url" ], ( str, unicode ) )
             self.__avatar_url = attributes[ "avatar_url" ]

src/github/Permissions.py

@@ -28,7 +28,6 @@ class Permissions( object ):
         self.__push = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "admin" in attributes and attributes[ "admin" ] is not None: # pragma no branch
             assert isinstance( attributes[ "admin" ], bool )
             self.__admin = attributes[ "admin" ]

src/github/Plan.py

@@ -33,7 +33,6 @@ class Plan( object ):
         self.__space = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "collaborators" in attributes and attributes[ "collaborators" ] is not None: # pragma no branch
             assert isinstance( attributes[ "collaborators" ], int )
             self.__collaborators = attributes[ "collaborators" ]

src/github/PullRequest.py

@@ -290,7 +290,6 @@ class PullRequest( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "additions" in attributes and attributes[ "additions" ] is not None: # pragma no branch
             self.__additions = attributes[ "additions" ]
         if "base" in attributes and attributes[ "base" ] is not None: # pragma no branch

src/github/PullRequestComment.py

@@ -117,7 +117,6 @@ class PullRequestComment( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "body" in attributes and attributes[ "body" ] is not None: # pragma no branch
             self.__body = attributes[ "body" ]
         if "commit_id" in attributes and attributes[ "commit_id" ] is not None: # pragma no branch

src/github/PullRequestFile.py

@@ -58,7 +58,6 @@ class PullRequestFile( object ):
         self.__status = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "additions" in attributes and attributes[ "additions" ] is not None: # pragma no branch
             self.__additions = attributes[ "additions" ]
         if "blob_url" in attributes and attributes[ "blob_url" ] is not None: # pragma no branch

src/github/Repository.py

@@ -865,7 +865,6 @@ class Repository( object ):
             None
         )
 
-    # @todo Remove '_identity' from the normalized json description
     @property
     def _identity( self ):
         return str( self.owner.login ) + "/" + str( self.name )
@@ -917,7 +916,6 @@ class Repository( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "clone_url" in attributes and attributes[ "clone_url" ] is not None: # pragma no branch
             assert isinstance( attributes[ "clone_url" ], ( str, unicode ) )
             self.__clone_url = attributes[ "clone_url" ]

src/github/RepositoryKey.py

@@ -83,7 +83,6 @@ class RepositoryKey( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "id" in attributes and attributes[ "id" ] is not None: # pragma no branch
             self.__id = attributes[ "id" ]
         if "key" in attributes and attributes[ "key" ] is not None: # pragma no branch

src/github/Tag.py

@@ -34,7 +34,6 @@ class Tag( object ):
         self.__zipball_url = None
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "commit" in attributes and attributes[ "commit" ] is not None: # pragma no branch
             assert isinstance( attributes[ "commit" ], dict )
             self.__commit = Commit.Commit( self.__requester, attributes[ "commit" ], completion = LazyCompletion )

src/github/Team.py

@@ -168,7 +168,6 @@ class Team( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "id" in attributes and attributes[ "id" ] is not None: # pragma no branch
             self.__id = attributes[ "id" ]
         if "members_count" in attributes and attributes[ "members_count" ] is not None: # pragma no branch

src/github/UserKey.py

@@ -83,7 +83,6 @@ class UserKey( object ):
         self.__completed = True
 
     def __useAttributes( self, attributes ):
-        # @todo No need to check if attribute is in attributes when attribute is mandatory
         if "id" in attributes and attributes[ "id" ] is not None: # pragma no branch
             self.__id = attributes[ "id" ]
         if "key" in attributes and attributes[ "key" ] is not None: # pragma no branch