diff --git a/codegen/JsonDescriptionOfGithubApiV3/description.000.human_readable.json b/codegen/JsonDescriptionOfGithubApiV3/description.000.human_readable.json index 9a7c7936..608c5370 100644 --- a/codegen/JsonDescriptionOfGithubApiV3/description.000.human_readable.json +++ b/codegen/JsonDescriptionOfGithubApiV3/description.000.human_readable.json @@ -1265,15 +1265,15 @@ ], "edit": { "mandatoryParameters": [ - { "name": "name", "type": "@todo" } + { "name": "name", "type": "string" } ], "optionalParameters": [ - { "name": "description", "type": "@todo" }, - { "name": "homepage", "type": "@todo" }, - { "name": "public", "type": "@todo" }, - { "name": "has_issues", "type": "@todo" }, - { "name": "has_wiki", "type": "@todo" }, - { "name": "has_downloads", "type": "@todo" } + { "name": "description", "type": "string" }, + { "name": "homepage", "type": "string" }, + { "name": "public", "type": "bool" }, + { "name": "has_issues", "type": "bool" }, + { "name": "has_wiki", "type": "bool" }, + { "name": "has_downloads", "type": "bool" } ] }, "attributes": [ @@ -1330,7 +1330,7 @@ "type": "CommitComment", "getList": true, "getElement": { - "parameter": { "name": "id", "type": "@todo" } + "parameter": { "name": "id", "type": "integer" } } }, { @@ -1339,12 +1339,12 @@ "type": "Commit", "getList": { "optionalParameters": [ - { "name": "sha", "type": "@todo" }, - { "name": "path", "type": "@todo" } + { "name": "sha", "type": "string" }, + { "name": "path", "type": "string" } ] }, "getElement": { - "parameter": { "name": "sha", "type": "@todo" } + "parameter": { "name": "sha", "type": "string" } } }, { @@ -1359,16 +1359,16 @@ "type": "Download", "getList": true, "getElement": { - "parameter": { "name": "id", "type": "@todo" } + "parameter": { "name": "id", "type": "integer" } }, "createElement": { "mandatoryParameters": [ - { "name": "name", "type": "@todo" }, - { "name": "size", "type": "@todo" } + { "name": "name", "type": "string" }, + { "name": "size", "type": "integer" } ], "optionalParameters": [ - { "name": "description", "type": "@todo" }, - { "name": "content_type", "type": "@todo" } + { "name": "description", "type": "string" }, + { "name": "content_type", "type": "string" } ] } }, @@ -1389,12 +1389,12 @@ "singularName": "git_blob", "type": "GitBlob", "getElement": { - "parameter": { "name": "sha", "type": "@todo" } + "parameter": { "name": "sha", "type": "string" } }, "createElement": { "mandatoryParameters": [ - { "name": "content", "type": "@todo" }, - { "name": "encoding", "type": "@todo" } + { "name": "content", "type": "string" }, + { "name": "encoding", "type": "string" } ] }, "url": [ @@ -1407,13 +1407,13 @@ "singularName": "git_commit", "type": "GitCommit", "getElement": { - "parameter": { "name": "sha", "type": "@todo" } + "parameter": { "name": "sha", "type": "string" } }, "createElement": { "mandatoryParameters": [ - { "name": "message", "type": "@todo" }, + { "name": "message", "type": "string" }, { "name": "tree", "type": "@todo" }, - { "name": "parents", "type": "@todo" } + { "name": "parents", "type": "list:GitCommit" } ], "optionalParameters": [ { "name": "author", "type": "@todo" }, @@ -1432,12 +1432,12 @@ "getList": true, "createElement": { "mandatoryParameters": [ - { "name": "ref", "type": "@todo" }, - { "name": "sha", "type": "@todo" } + { "name": "ref", "type": "string" }, + { "name": "sha", "type": "string" } ] }, "getElement": { - "parameter": { "name": "ref", "type": "@todo" }, + "parameter": { "name": "ref", "type": "string" }, "request": { "url": [ { "type": "attribute", "value": [ "url" ] }, @@ -1457,17 +1457,17 @@ "type": "GitTag", "createElement": { "mandatoryParameters": [ - { "name": "tag", "type": "@todo" }, - { "name": "message", "type": "@todo" }, - { "name": "object", "type": "@todo" }, - { "name": "type", "type": "@todo" } + { "name": "tag", "type": "string" }, + { "name": "message", "type": "string" }, + { "name": "object", "type": "string" }, + { "name": "type", "type": "string" } ], "optionalParameters": [ { "name": "tagger", "type": "@todo" } ] }, "getElement": { - "parameter": { "name": "sha", "type": "@todo" } + "parameter": { "name": "sha", "type": "string" } }, "url": [ { "type": "attribute", "value": [ "url" ] }, @@ -1487,7 +1487,7 @@ ] }, "getElement": { - "parameter": { "name": "sha", "type": "@todo" }, + "parameter": { "name": "sha", "type": "string" }, "optionalParameters": [ { "name": "recursive", "type": "bool" } ] @@ -1504,16 +1504,16 @@ "getList": true, "createElement": { "mandatoryParameters": [ - { "name": "name", "type": "@todo" }, + { "name": "name", "type": "string" }, { "name": "config", "type": "@todo" } ], "optionalParameters": [ - { "name": "events", "type": "@todo" }, - { "name": "active", "type": "@todo" } + { "name": "events", "type": "list:string" }, + { "name": "active", "type": "bool" } ] }, "getElement": { - "parameter": { "name": "id", "type": "@todo" } + "parameter": { "name": "id", "type": "integer" } } }, { @@ -1522,29 +1522,29 @@ "type": "Issue", "getList": { "optionalParameters": [ - { "name": "milestone", "type": "@todo" }, - { "name": "state", "type": "@todo" }, - { "name": "assignee", "type": "@todo" }, - { "name": "mentioned", "type": "@todo" }, - { "name": "labels", "type": "@todo" }, - { "name": "sort", "type": "@todo" }, - { "name": "direction", "type": "@todo" }, - { "name": "since", "type": "@todo" } + { "name": "milestone", "type": "integer" }, + { "name": "state", "type": "string" }, + { "name": "assignee", "type": "string" }, + { "name": "mentioned", "type": "string" }, + { "name": "labels", "type": "list:string" }, + { "name": "sort", "type": "string" }, + { "name": "direction", "type": "string" }, + { "name": "since", "type": "string" } ] }, "createElement": { "mandatoryParameters": [ - { "name": "title", "type": "@todo" } + { "name": "title", "type": "string" } ], "optionalParameters": [ - { "name": "body", "type": "@todo" }, - { "name": "assignee", "type": "@todo" }, - { "name": "milestone", "type": "@todo" }, - { "name": "labels", "type": "@todo" } + { "name": "body", "type": "string" }, + { "name": "assignee", "type": "string" }, + { "name": "milestone", "type": "integer" }, + { "name": "labels", "type": "list:string" } ] }, "getElement": { - "parameter": { "name": "number", "type": "@todo" } + "parameter": { "name": "number", "type": "integer" } } }, { @@ -1553,7 +1553,7 @@ "type": "IssueEvent", "getList": true, "getElement": { - "parameter": { "name": "id", "type": "@todo" } + "parameter": { "name": "id", "type": "integer" } }, "url": [ { "type": "attribute", "value": [ "url" ] }, @@ -1567,12 +1567,12 @@ "getList": true, "createElement": { "mandatoryParameters": [ - { "name": "title", "type": "@todo" }, - { "name": "key", "type": "@todo" } + { "name": "title", "type": "string" }, + { "name": "key", "type": "string" } ] }, "getElement": { - "parameter": { "name": "id", "type": "@todo" } + "parameter": { "name": "id", "type": "integer" } } }, { @@ -1582,12 +1582,12 @@ "getList": true, "createElement": { "mandatoryParameters": [ - { "name": "name", "type": "@todo" }, - { "name": "color", "type": "@todo" } + { "name": "name", "type": "string" }, + { "name": "color", "type": "string" } ] }, "getElement": { - "parameter": { "name": "name", "type": "@todo" }, + "parameter": { "name": "name", "type": "string" }, "request": { "url": [ { "type": "attribute", "value": [ "url" ] }, @@ -1608,23 +1608,23 @@ "type": "Milestone", "getList": { "optionalParameters": [ - { "name": "state", "type": "@todo" }, - { "name": "sort", "type": "@todo" }, - { "name": "direction", "type": "@todo" } + { "name": "state", "type": "string" }, + { "name": "sort", "type": "string" }, + { "name": "direction", "type": "string" } ] }, "createElement": { "mandatoryParameters": [ - { "name": "title", "type": "@todo" } + { "name": "title", "type": "string" } ], "optionalParameters": [ - { "name": "state", "type": "@todo" }, - { "name": "description", "type": "@todo" }, - { "name": "due_on", "type": "@todo" } + { "name": "state", "type": "string" }, + { "name": "description", "type": "string" }, + { "name": "due_on", "type": "string" } ] }, "getElement": { - "parameter": { "name": "number", "type": "@todo" } + "parameter": { "name": "number", "type": "integer" } } }, { @@ -1633,17 +1633,17 @@ "type": "PullRequest", "getList": { "optionalParameters": [ - { "name": "state", "type": "@todo" } + { "name": "state", "type": "string" } ] }, "getElement": { - "parameter": { "name": "number", "type": "@todo" } + "parameter": { "name": "number", "type": "integer" } }, "createElement": { "optionalParameters": [ - { "name": "title", "type": "@todo" }, - { "name": "body", "type": "@todo" }, - { "name": "issue", "type": "@todo" }, + { "name": "title", "type": "string" }, + { "name": "body", "type": "string" }, + { "name": "issue", "type": "integer" }, { "name": "base", "type": "@todo" }, { "name": "head", "type": "@todo" } ] @@ -1722,8 +1722,8 @@ "isCompletable": true, "edit": { "optionalParameters": [ - { "name": "title", "type": "@todo" }, - { "name": "key", "type": "@todo" } + { "name": "title", "type": "string" }, + { "name": "key", "type": "string" } ] }, "delete": true, diff --git a/codegen/JsonDescriptionOfGithubApiV3/description.001.normalized.json b/codegen/JsonDescriptionOfGithubApiV3/description.001.normalized.json index e7727676..33811ddf 100644 --- a/codegen/JsonDescriptionOfGithubApiV3/description.001.normalized.json +++ b/codegen/JsonDescriptionOfGithubApiV3/description.001.normalized.json @@ -7496,7 +7496,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "name" } @@ -7520,7 +7520,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "description" }, @@ -7528,7 +7528,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "homepage" }, @@ -7536,7 +7536,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "bool" }, "name": "public" }, @@ -7544,7 +7544,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "bool" }, "name": "has_issues" }, @@ -7552,7 +7552,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "bool" }, "name": "has_wiki" }, @@ -7560,7 +7560,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "bool" }, "name": "has_downloads" } @@ -7800,7 +7800,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "integer" }, "name": "id" } @@ -7881,7 +7881,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "sha" } @@ -7949,7 +7949,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "sha" }, @@ -7957,7 +7957,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "path" } @@ -8010,7 +8010,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "name" }, @@ -8018,7 +8018,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "integer" }, "name": "size" } @@ -8046,7 +8046,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "description" }, @@ -8054,7 +8054,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "content_type" } @@ -8076,7 +8076,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "integer" }, "name": "id" } @@ -8219,7 +8219,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "content" }, @@ -8227,7 +8227,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "encoding" } @@ -8268,7 +8268,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "sha" } @@ -8318,7 +8318,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "message" }, @@ -8332,9 +8332,9 @@ }, { "type": { - "simple": true, - "cardinality": "scalar", - "name": "@todo" + "simple": false, + "cardinality": "list", + "name": "GitCommit" }, "name": "parents" } @@ -8392,7 +8392,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "sha" } @@ -8442,7 +8442,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "ref" }, @@ -8450,7 +8450,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "sha" } @@ -8491,7 +8491,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "ref" } @@ -8568,7 +8568,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "tag" }, @@ -8576,7 +8576,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "message" }, @@ -8584,7 +8584,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "object" }, @@ -8592,7 +8592,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "type" } @@ -8642,7 +8642,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "sha" } @@ -8742,7 +8742,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "sha" } @@ -8801,7 +8801,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "name" }, @@ -8836,8 +8836,8 @@ { "type": { "simple": true, - "cardinality": "scalar", - "name": "@todo" + "cardinality": "list", + "name": "string" }, "name": "events" }, @@ -8845,7 +8845,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "bool" }, "name": "active" } @@ -8867,7 +8867,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "integer" }, "name": "id" } @@ -8948,7 +8948,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "title" } @@ -8976,7 +8976,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "body" }, @@ -8984,7 +8984,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "assignee" }, @@ -8992,15 +8992,15 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "integer" }, "name": "milestone" }, { "type": { "simple": true, - "cardinality": "scalar", - "name": "@todo" + "cardinality": "list", + "name": "string" }, "name": "labels" } @@ -9022,7 +9022,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "integer" }, "name": "number" } @@ -9090,7 +9090,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "integer" }, "name": "milestone" }, @@ -9098,7 +9098,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "state" }, @@ -9106,7 +9106,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "assignee" }, @@ -9114,15 +9114,15 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "mentioned" }, { "type": { "simple": true, - "cardinality": "scalar", - "name": "@todo" + "cardinality": "list", + "name": "string" }, "name": "labels" }, @@ -9130,7 +9130,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "sort" }, @@ -9138,7 +9138,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "direction" }, @@ -9146,7 +9146,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "since" } @@ -9168,7 +9168,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "integer" }, "name": "id" } @@ -9249,7 +9249,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "title" }, @@ -9257,7 +9257,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "key" } @@ -9298,7 +9298,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "integer" }, "name": "id" } @@ -9379,7 +9379,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "name" }, @@ -9387,7 +9387,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "color" } @@ -9428,7 +9428,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "name" } @@ -9510,7 +9510,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "title" } @@ -9538,7 +9538,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "state" }, @@ -9546,7 +9546,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "description" }, @@ -9554,7 +9554,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "due_on" } @@ -9576,7 +9576,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "integer" }, "name": "number" } @@ -9644,7 +9644,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "state" }, @@ -9652,7 +9652,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "sort" }, @@ -9660,7 +9660,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "direction" } @@ -9701,7 +9701,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "title" }, @@ -9709,7 +9709,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "body" }, @@ -9717,7 +9717,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "integer" }, "name": "issue" }, @@ -9755,7 +9755,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "integer" }, "name": "number" } @@ -9823,7 +9823,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "state" } @@ -10138,7 +10138,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "title" }, @@ -10146,7 +10146,7 @@ "type": { "simple": true, "cardinality": "scalar", - "name": "@todo" + "name": "string" }, "name": "key" } diff --git a/codegen/templates/GithubObject.MethodBody.DoRequest.py b/codegen/templates/GithubObject.MethodBody.DoRequest.py index 55a9cbef..6075a0e2 100644 --- a/codegen/templates/GithubObject.MethodBody.DoRequest.py +++ b/codegen/templates/GithubObject.MethodBody.DoRequest.py @@ -45,7 +45,7 @@ assert isinstance( {{ parameter.name }}, list ) and ( len( {{ parameter.name }} ) == 0 or isinstance( {{ parameter.name }}[ 0 ], bool ) ), {{ parameter.name }} {% endif %} {% else %} - assert isinstance( {{ parameter.name }}, list ) and ( {{ parameter.name }} ) == 0 or isinstance( {{ parameter.name }}[ 0 ], {{ parameter.type.name }}.{{ parameter.type.name }} ) ), {{ parameter.name }} + assert isinstance( {{ parameter.name }}, list ) and ( len( {{ parameter.name }} ) == 0 or isinstance( {{ parameter.name }}[ 0 ], {{ parameter.type.name }}.{{ parameter.type.name }} ) ), {{ parameter.name }} {% endif %} {% endif %} diff --git a/doc/ReferenceOfClasses.md b/doc/ReferenceOfClasses.md index 638cb8f7..deae6fb7 100644 --- a/doc/ReferenceOfClasses.md +++ b/doc/ReferenceOfClasses.md @@ -996,16 +996,16 @@ Collaborators Comments -------- * `get_comment( id )`: `CommitComment` - * `id` + * `id`: integer * `get_comments()`: list of `CommitComment` Commits ------- * `get_commit( sha )`: `Commit` - * `sha` + * `sha`: string * `get_commits( [sha, path] )`: list of `Commit` - * `sha` - * `path` + * `sha`: string + * `path`: string Contributors ------------ @@ -1014,12 +1014,12 @@ Contributors Downloads --------- * `create_download( name, size, [description, content_type] )`: `Download` - * `name` - * `size` - * `description` - * `content_type` + * `name`: string + * `size`: integer + * `description`: string + * `content_type`: string * `get_download( id )`: `Download` - * `id` + * `id`: integer * `get_downloads()`: list of `Download` Events @@ -1034,41 +1034,41 @@ Forks Git_blobs --------- * `create_git_blob( content, encoding )`: `GitBlob` - * `content` - * `encoding` + * `content`: string + * `encoding`: string * `get_git_blob( sha )`: `GitBlob` - * `sha` + * `sha`: string Git_commits ----------- * `create_git_commit( message, tree, parents, [author, committer] )`: `GitCommit` - * `message` + * `message`: string * `tree` - * `parents` + * `parents`: list of `GitCommit` * `author` * `committer` * `get_git_commit( sha )`: `GitCommit` - * `sha` + * `sha`: string Git_refs -------- * `create_git_ref( ref, sha )`: `GitRef` - * `ref` - * `sha` + * `ref`: string + * `sha`: string * `get_git_ref( ref )`: `GitRef` - * `ref` + * `ref`: string * `get_git_refs()`: list of `GitRef` Git_tags -------- * `create_git_tag( tag, message, object, type, [tagger] )`: `GitTag` - * `tag` - * `message` - * `object` - * `type` + * `tag`: string + * `message`: string + * `object`: string + * `type`: string * `tagger` * `get_git_tag( sha )`: `GitTag` - * `sha` + * `sha`: string Git_trees --------- @@ -1076,62 +1076,62 @@ Git_trees * `tree` * `base_tree` * `get_git_tree( sha, [recursive] )`: `GitTree` - * `sha` + * `sha`: string * `recursive`: bool Hooks ----- * `create_hook( name, config, [events, active] )`: `Hook` - * `name` + * `name`: string * `config` - * `events` - * `active` + * `events`: list of string + * `active`: bool * `get_hook( id )`: `Hook` - * `id` + * `id`: integer * `get_hooks()`: list of `Hook` Issues ------ * `create_issue( title, [body, assignee, milestone, labels] )`: `Issue` - * `title` - * `body` - * `assignee` - * `milestone` - * `labels` + * `title`: string + * `body`: string + * `assignee`: string + * `milestone`: integer + * `labels`: list of string * `get_issue( number )`: `Issue` - * `number` + * `number`: integer * `get_issues( [milestone, state, assignee, mentioned, labels, sort, direction, since] )`: list of `Issue` - * `milestone` - * `state` - * `assignee` - * `mentioned` - * `labels` - * `sort` - * `direction` - * `since` + * `milestone`: integer + * `state`: string + * `assignee`: string + * `mentioned`: string + * `labels`: list of string + * `sort`: string + * `direction`: string + * `since`: string Issues_events ------------- * `get_issues_event( id )`: `IssueEvent` - * `id` + * `id`: integer * `get_issues_events()`: list of `IssueEvent` Keys ---- * `create_key( title, key )`: `RepositoryKey` - * `title` - * `key` + * `title`: string + * `key`: string * `get_key( id )`: `RepositoryKey` - * `id` + * `id`: integer * `get_keys()`: list of `RepositoryKey` Labels ------ * `create_label( name, color )`: `Label` - * `name` - * `color` + * `name`: string + * `color`: string * `get_label( name )`: `Label` - * `name` + * `name`: string * `get_labels()`: list of `Label` Languages @@ -1141,40 +1141,40 @@ Languages Milestones ---------- * `create_milestone( title, [state, description, due_on] )`: `Milestone` - * `title` - * `state` - * `description` - * `due_on` + * `title`: string + * `state`: string + * `description`: string + * `due_on`: string * `get_milestone( number )`: `Milestone` - * `number` + * `number`: integer * `get_milestones( [state, sort, direction] )`: list of `Milestone` - * `state` - * `sort` - * `direction` + * `state`: string + * `sort`: string + * `direction`: string Modification ------------ * `edit( name, [description, homepage, public, has_issues, has_wiki, has_downloads] )` - * `name` - * `description` - * `homepage` - * `public` - * `has_issues` - * `has_wiki` - * `has_downloads` + * `name`: string + * `description`: string + * `homepage`: string + * `public`: bool + * `has_issues`: bool + * `has_wiki`: bool + * `has_downloads`: bool Pulls ----- * `create_pull( < title, body, base, head > or < issue, base, head > )`: `PullRequest` - * `title` - * `body` - * `issue` + * `title`: string + * `body`: string + * `issue`: integer * `base` * `head` * `get_pull( number )`: `PullRequest` - * `number` + * `number`: integer * `get_pulls( [state] )`: list of `PullRequest` - * `state` + * `state`: string Tags ---- @@ -1206,8 +1206,8 @@ Deletion Modification ------------ * `edit( [title, key] )` - * `title` - * `key` + * `title`: string + * `key`: string Class `Tag` =========== diff --git a/src/github/Repository.py b/src/github/Repository.py index e9cbf86a..59297e48 100644 --- a/src/github/Repository.py +++ b/src/github/Repository.py @@ -204,6 +204,12 @@ class Repository( object ): return data def create_download( self, name, size, description = DefaultValueForOptionalParameters, content_type = DefaultValueForOptionalParameters ): + assert isinstance( name, ( str, unicode ) ), name + assert isinstance( size, int ), size + if description is not DefaultValueForOptionalParameters: + assert isinstance( description, ( str, unicode ) ), description + if content_type is not DefaultValueForOptionalParameters: + assert isinstance( content_type, ( str, unicode ) ), content_type post_parameters = { "name": name, "size": size, @@ -220,6 +226,8 @@ class Repository( object ): return Download.Download( self.__requester, data, completion = NoCompletion ) def create_git_blob( self, content, encoding ): + assert isinstance( content, ( str, unicode ) ), content + assert isinstance( encoding, ( str, unicode ) ), encoding post_parameters = { "content": content, "encoding": encoding, @@ -232,6 +240,8 @@ class Repository( object ): return GitBlob.GitBlob( self.__requester, data, completion = NoCompletion ) def create_git_commit( self, message, tree, parents, author = DefaultValueForOptionalParameters, committer = DefaultValueForOptionalParameters ): + assert isinstance( message, ( str, unicode ) ), message + assert isinstance( parents, list ) and ( len( parents ) == 0 or isinstance( parents[ 0 ], GitCommit.GitCommit ) ), parents post_parameters = { "message": message, "tree": tree, @@ -249,6 +259,8 @@ class Repository( object ): return GitCommit.GitCommit( self.__requester, data, completion = NoCompletion ) def create_git_ref( self, ref, sha ): + assert isinstance( ref, ( str, unicode ) ), ref + assert isinstance( sha, ( str, unicode ) ), sha post_parameters = { "ref": ref, "sha": sha, @@ -261,6 +273,10 @@ class Repository( object ): return GitRef.GitRef( self.__requester, data, completion = NoCompletion ) def create_git_tag( self, tag, message, object, type, tagger = DefaultValueForOptionalParameters ): + assert isinstance( tag, ( str, unicode ) ), tag + assert isinstance( message, ( str, unicode ) ), message + assert isinstance( object, ( str, unicode ) ), object + assert isinstance( type, ( str, unicode ) ), type post_parameters = { "tag": tag, "message": message, @@ -290,6 +306,11 @@ class Repository( object ): return GitTree.GitTree( self.__requester, data, completion = NoCompletion ) def create_hook( self, name, config, events = DefaultValueForOptionalParameters, active = DefaultValueForOptionalParameters ): + assert isinstance( name, ( str, unicode ) ), name + if events is not DefaultValueForOptionalParameters: + assert isinstance( events, list ) and ( len( events ) == 0 or isinstance( events[ 0 ], ( str, unicode ) ) ), events + if active is not DefaultValueForOptionalParameters: + assert isinstance( active, bool ), active post_parameters = { "name": name, "config": config, @@ -306,6 +327,15 @@ class Repository( object ): return Hook.Hook( self.__requester, data, completion = NoCompletion ) def create_issue( self, title, body = DefaultValueForOptionalParameters, assignee = DefaultValueForOptionalParameters, milestone = DefaultValueForOptionalParameters, labels = DefaultValueForOptionalParameters ): + assert isinstance( title, ( str, unicode ) ), title + if body is not DefaultValueForOptionalParameters: + assert isinstance( body, ( str, unicode ) ), body + if assignee is not DefaultValueForOptionalParameters: + assert isinstance( assignee, ( str, unicode ) ), assignee + if milestone is not DefaultValueForOptionalParameters: + assert isinstance( milestone, int ), milestone + if labels is not DefaultValueForOptionalParameters: + assert isinstance( labels, list ) and ( len( labels ) == 0 or isinstance( labels[ 0 ], ( str, unicode ) ) ), labels post_parameters = { "title": title, } @@ -325,6 +355,8 @@ class Repository( object ): return Issue.Issue( self.__requester, data, completion = NoCompletion ) def create_key( self, title, key ): + assert isinstance( title, ( str, unicode ) ), title + assert isinstance( key, ( str, unicode ) ), key post_parameters = { "title": title, "key": key, @@ -337,6 +369,8 @@ class Repository( object ): return RepositoryKey.RepositoryKey( self.__requester, data, completion = NoCompletion, repoUrl = self.url ) def create_label( self, name, color ): + assert isinstance( name, ( str, unicode ) ), name + assert isinstance( color, ( str, unicode ) ), color post_parameters = { "name": name, "color": color, @@ -349,6 +383,13 @@ class Repository( object ): return Label.Label( self.__requester, data, completion = NoCompletion ) def create_milestone( self, title, state = DefaultValueForOptionalParameters, description = DefaultValueForOptionalParameters, due_on = DefaultValueForOptionalParameters ): + assert isinstance( title, ( str, unicode ) ), title + if state is not DefaultValueForOptionalParameters: + assert isinstance( state, ( str, unicode ) ), state + if description is not DefaultValueForOptionalParameters: + assert isinstance( description, ( str, unicode ) ), description + if due_on is not DefaultValueForOptionalParameters: + assert isinstance( due_on, ( str, unicode ) ), due_on post_parameters = { "title": title, } @@ -372,9 +413,12 @@ class Repository( object ): return self.__create_pull_2( *args, **kwds ) def __create_pull_1( self, title, body, base, head ): + assert isinstance( title, ( str, unicode ) ), title + assert isinstance( body, ( str, unicode ) ), body return self.__create_pull( title = title, body = body, base = base, head = head ) def __create_pull_2( self, issue, base, head ): + assert isinstance( issue, int ), issue return self.__create_pull( issue = issue, base = base, head = head ) def __create_pull( self, **kwds ): @@ -387,6 +431,19 @@ class Repository( object ): return PullRequest.PullRequest( self.__requester, data, completion = NoCompletion ) def edit( self, name, description = DefaultValueForOptionalParameters, homepage = DefaultValueForOptionalParameters, public = DefaultValueForOptionalParameters, has_issues = DefaultValueForOptionalParameters, has_wiki = DefaultValueForOptionalParameters, has_downloads = DefaultValueForOptionalParameters ): + assert isinstance( name, ( str, unicode ) ), name + if description is not DefaultValueForOptionalParameters: + assert isinstance( description, ( str, unicode ) ), description + if homepage is not DefaultValueForOptionalParameters: + assert isinstance( homepage, ( str, unicode ) ), homepage + if public is not DefaultValueForOptionalParameters: + assert isinstance( public, bool ), public + if has_issues is not DefaultValueForOptionalParameters: + assert isinstance( has_issues, bool ), has_issues + if has_wiki is not DefaultValueForOptionalParameters: + assert isinstance( has_wiki, bool ), has_wiki + if has_downloads is not DefaultValueForOptionalParameters: + assert isinstance( has_downloads, bool ), has_downloads post_parameters = { "name": name, } @@ -436,6 +493,7 @@ class Repository( object ): ) def get_comment( self, id ): + assert isinstance( id, int ), id status, headers, data = self.__requester.request( "GET", str( self.url ) + "/comments" + "/" + str( id ), @@ -457,6 +515,7 @@ class Repository( object ): ) def get_commit( self, sha ): + assert isinstance( sha, ( str, unicode ) ), sha status, headers, data = self.__requester.request( "GET", str( self.url ) + "/commits" + "/" + str( sha ), @@ -465,6 +524,10 @@ class Repository( object ): return Commit.Commit( self.__requester, data, completion = NoCompletion ) def get_commits( self, sha = DefaultValueForOptionalParameters, path = DefaultValueForOptionalParameters ): + if sha is not DefaultValueForOptionalParameters: + assert isinstance( sha, ( str, unicode ) ), sha + if path is not DefaultValueForOptionalParameters: + assert isinstance( path, ( str, unicode ) ), path status, headers, data = self.__requester.request( "GET", str( self.url ) + "/commits", @@ -491,6 +554,7 @@ class Repository( object ): ) def get_download( self, id ): + assert isinstance( id, int ), id status, headers, data = self.__requester.request( "GET", str( self.url ) + "/downloads" + "/" + str( id ), @@ -538,6 +602,7 @@ class Repository( object ): ) def get_git_blob( self, sha ): + assert isinstance( sha, ( str, unicode ) ), sha status, headers, data = self.__requester.request( "GET", str( self.url ) + "/git/blobs" + "/" + str( sha ), @@ -546,6 +611,7 @@ class Repository( object ): return GitBlob.GitBlob( self.__requester, data, completion = NoCompletion ) def get_git_commit( self, sha ): + assert isinstance( sha, ( str, unicode ) ), sha status, headers, data = self.__requester.request( "GET", str( self.url ) + "/git/commits" + "/" + str( sha ), @@ -554,6 +620,7 @@ class Repository( object ): return GitCommit.GitCommit( self.__requester, data, completion = NoCompletion ) def get_git_ref( self, ref ): + assert isinstance( ref, ( str, unicode ) ), ref status, headers, data = self.__requester.request( "GET", str( self.url ) + "/git/" + str( ref ), @@ -575,6 +642,7 @@ class Repository( object ): ) def get_git_tag( self, sha ): + assert isinstance( sha, ( str, unicode ) ), sha status, headers, data = self.__requester.request( "GET", str( self.url ) + "/git/tags" + "/" + str( sha ), @@ -583,6 +651,7 @@ class Repository( object ): return GitTag.GitTag( self.__requester, data, completion = NoCompletion ) def get_git_tree( self, sha, recursive = DefaultValueForOptionalParameters ): + assert isinstance( sha, ( str, unicode ) ), sha if recursive is not DefaultValueForOptionalParameters: assert isinstance( recursive, bool ), recursive status, headers, data = self.__requester.request( @@ -593,6 +662,7 @@ class Repository( object ): return GitTree.GitTree( self.__requester, data, completion = NoCompletion ) def get_hook( self, id ): + assert isinstance( id, int ), id status, headers, data = self.__requester.request( "GET", str( self.url ) + "/hooks" + "/" + str( id ), @@ -614,6 +684,7 @@ class Repository( object ): ) def get_issue( self, number ): + assert isinstance( number, int ), number status, headers, data = self.__requester.request( "GET", str( self.url ) + "/issues" + "/" + str( number ), @@ -622,6 +693,22 @@ class Repository( object ): return Issue.Issue( self.__requester, data, completion = NoCompletion ) def get_issues( self, milestone = DefaultValueForOptionalParameters, state = DefaultValueForOptionalParameters, assignee = DefaultValueForOptionalParameters, mentioned = DefaultValueForOptionalParameters, labels = DefaultValueForOptionalParameters, sort = DefaultValueForOptionalParameters, direction = DefaultValueForOptionalParameters, since = DefaultValueForOptionalParameters ): + if milestone is not DefaultValueForOptionalParameters: + assert isinstance( milestone, int ), milestone + if state is not DefaultValueForOptionalParameters: + assert isinstance( state, ( str, unicode ) ), state + if assignee is not DefaultValueForOptionalParameters: + assert isinstance( assignee, ( str, unicode ) ), assignee + if mentioned is not DefaultValueForOptionalParameters: + assert isinstance( mentioned, ( str, unicode ) ), mentioned + if labels is not DefaultValueForOptionalParameters: + assert isinstance( labels, list ) and ( len( labels ) == 0 or isinstance( labels[ 0 ], ( str, unicode ) ) ), labels + if sort is not DefaultValueForOptionalParameters: + assert isinstance( sort, ( str, unicode ) ), sort + if direction is not DefaultValueForOptionalParameters: + assert isinstance( direction, ( str, unicode ) ), direction + if since is not DefaultValueForOptionalParameters: + assert isinstance( since, ( str, unicode ) ), since status, headers, data = self.__requester.request( "GET", str( self.url ) + "/issues", @@ -635,6 +722,7 @@ class Repository( object ): ) def get_issues_event( self, id ): + assert isinstance( id, int ), id status, headers, data = self.__requester.request( "GET", str( self.url ) + "/issues/events" + "/" + str( id ), @@ -656,6 +744,7 @@ class Repository( object ): ) def get_key( self, id ): + assert isinstance( id, int ), id status, headers, data = self.__requester.request( "GET", str( self.url ) + "/keys" + "/" + str( id ), @@ -677,6 +766,7 @@ class Repository( object ): ) def get_label( self, name ): + assert isinstance( name, ( str, unicode ) ), name status, headers, data = self.__requester.request( "GET", str( self.url ) + "/labels/" + urllib.quote( str( name ) ), @@ -706,6 +796,7 @@ class Repository( object ): return data def get_milestone( self, number ): + assert isinstance( number, int ), number status, headers, data = self.__requester.request( "GET", str( self.url ) + "/milestones" + "/" + str( number ), @@ -714,6 +805,12 @@ class Repository( object ): return Milestone.Milestone( self.__requester, data, completion = NoCompletion ) def get_milestones( self, state = DefaultValueForOptionalParameters, sort = DefaultValueForOptionalParameters, direction = DefaultValueForOptionalParameters ): + if state is not DefaultValueForOptionalParameters: + assert isinstance( state, ( str, unicode ) ), state + if sort is not DefaultValueForOptionalParameters: + assert isinstance( sort, ( str, unicode ) ), sort + if direction is not DefaultValueForOptionalParameters: + assert isinstance( direction, ( str, unicode ) ), direction status, headers, data = self.__requester.request( "GET", str( self.url ) + "/milestones", @@ -740,6 +837,7 @@ class Repository( object ): ) def get_pull( self, number ): + assert isinstance( number, int ), number status, headers, data = self.__requester.request( "GET", str( self.url ) + "/pulls" + "/" + str( number ), @@ -748,6 +846,8 @@ class Repository( object ): return PullRequest.PullRequest( self.__requester, data, completion = NoCompletion ) def get_pulls( self, state = DefaultValueForOptionalParameters ): + if state is not DefaultValueForOptionalParameters: + assert isinstance( state, ( str, unicode ) ), state status, headers, data = self.__requester.request( "GET", str( self.url ) + "/pulls", diff --git a/src/github/RepositoryKey.py b/src/github/RepositoryKey.py index 9127cb50..297f6554 100644 --- a/src/github/RepositoryKey.py +++ b/src/github/RepositoryKey.py @@ -51,6 +51,10 @@ class RepositoryKey( object ): ) def edit( self, title = DefaultValueForOptionalParameters, key = DefaultValueForOptionalParameters ): + if title is not DefaultValueForOptionalParameters: + assert isinstance( title, ( str, unicode ) ), title + if key is not DefaultValueForOptionalParameters: + assert isinstance( key, ( str, unicode ) ), key post_parameters = { } if title is not DefaultValueForOptionalParameters: