docs: missing docstrings for functions & classes #13

tina80lvl · 2020-10-01T12:12:07Z

No description provided.

Release-As: 2.2.a0 Co-authored-by: larkee <[email protected]>

…is#462)

…apis#480) Add googleapis/python-test-utils and system test stub

…oogleapis#487)

Release-As: 2.2.a1

…-django

fix: Couple of tests are permanently broken while running locally

# Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

IlyaFaer

I still have some comments. @mf2199, could you take a look too?

google/cloud/spanner_dbapi/connection.py

google/cloud/spanner_dbapi/cursor.py

IlyaFaer · 2020-10-12T13:45:41Z

google/cloud/spanner_dbapi/cursor.py

        return self._itr

    def fetchone(self):
+        """Fetch next resulting row of the last ran query.


Fetch the next resulting row

google/cloud/spanner_dbapi/utils.py

google/cloud/spanner_dbapi/cursor.py

mf2199

I've reviewed the Connection and Cursor classes. The rest can be fixed using similar ideas.

google/cloud/spanner_dbapi/parser.py

google/cloud/spanner_dbapi/connection.py

google/cloud/spanner_dbapi/cursor.py

google/cloud/spanner_dbapi/connection.py

google/cloud/spanner_dbapi/parse_utils.py

google/cloud/spanner_dbapi/parser.py

google/cloud/spanner_dbapi/version.py

mf2199 · 2020-10-29T17:54:50Z

google/cloud/spanner_dbapi/cursor.py

+        """The number of rows produced by the last `.execute()`.
+
+        :rtype: int
+        :returns: The number of rows that last .execute*() produced.


:returns: The number of rows produced by the last .execute*().

mf2199 · 2020-10-29T17:55:42Z

google/cloud/spanner_dbapi/parse_utils.py

+    :param params: A list of parameters.
+
+    :rtype: dict
+    :returns: A dictionary of the name to the list of parameters.


Rephrase, please.

mf2199 · 2020-10-29T18:01:30Z

google/cloud/spanner_dbapi/parse_utils.py

+    :param params: A list of parameters.
+
+    :rtype: list
+    :returns: A list of tuples of the parameters.


:returns: A properly restructured list of the parameters.

google/cloud/spanner_dbapi/utils.py

mf2199 · 2020-10-30T19:30:34Z

google/cloud/spanner_dbapi/utils.py

+
+    :rtype: str
+    :returns: A SQL parsed by segments in unicode if initial
+             SQL is valid, initial string otherwise.


Indentation should match the first description character of the previous line - in this case, A.

mf2199 · 2020-10-30T19:31:12Z

google/cloud/spanner_dbapi/parser.py

+    :rtype: (str, Any)
+    :returns: A tuple of the rest expression string and tree of already parsed
+              expression.
+    :raises :class:`ProgrammingError`: If there is parsing error.


a parsing error

mf2199 · 2020-10-30T19:32:57Z

google/cloud/spanner_dbapi/parser.py

+    :param token: An expression token.
+
+    :rtype: (str, Any)
+    :returns: A tuple of the rest expression string and tree of already parsed


A tuple containing the rest of the expression string and the tree of the already parsed

mf2199 · 2020-10-30T19:33:41Z

google/cloud/spanner_dbapi/parser.py

+        """Return False if all the arguments have the same length.
+
+        :rtype: bool
+        :return: False if the sequences of arguments have the same length.


the arguments

mf2199 · 2020-10-30T19:34:38Z

google/cloud/spanner_dbapi/parser.py

+        :return: True if all the arguments are in pyformat and have the same
+                 number of arguments, False otherwise.


arguments have the same number of arguments?

Rephrase.

mf2199 · 2020-10-30T19:35:31Z

google/cloud/spanner_dbapi/parse_utils.py

+    :param params: A list of parameters.
+
+    :rtype: tuple(str, dict)
+    :returns: A tuple of sanitized SQL and dictionary of the named arguments.


A tuple of the sanitized SQL and a dictionary of the named arguments.

larkee and others added 30 commits May 26, 2020 14:09

feat: release 2.2a0 (googleapis#457)

11222db

Release-As: 2.2.a0 Co-authored-by: larkee <[email protected]>

feat: [WIP] The first stage of nox implementation (googleapis#468)

5551b58

feat: refactor connect() function, cover it with unit tests (googleap…

bfde221

…is#462)

feat: Stage 2 of nox implementation - adding docs target (googlea…

e017901

…pis#473)

fix: Fix black, isort compatibility (googleapis#469)

144bdc2

feat: Stage 3-4 of nox implementation - adding auto-format targets (g…

7a1f6a6

…oogleapis#478)

feat: Stage 5 of nox implementation - adding coverage targets (goog…

acd9209

…leapis#479)

feat: cursor must detect if the parent connection is closed (googleap…

6028f88

…is#463)

feat: Stage 6 of nox implementation - enabling system tests (google…

94ba284

…apis#480) Add googleapis/python-test-utils and system test stub

chore: Code refactoring to follow common Google API scheme - Stage I (g…

59eb432

…oogleapis#487)

chore: release 2.2a1 (googleapis#499)

048566c

Release-As: 2.2.a1

Merge branch 'master' of https://github.com/googleapis/python-spanner…

f5719f8

…-django

fix: Couple of tests are permanently broken while running locally

2c0c0a2

fix: offset for current timezone

05bf7dc

clean: whitespace

31185df

fix: localtime->gmtime

bd605a5

fix: gmtime->localtime

23f87ad

refactor

216a92b

docs: utils.py

3b34162

docs: version.py`

d5ba00c

refactor

ccfb6ce

Merge pull request #5 from q-logic/fix-472

9526cc2

fix: Couple of tests are permanently broken while running locally

Merge remote-tracking branch 'upstream/master'

a921666

# Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

docs: parser.py

60fd3fb

refactor

d86e8a1

docs: parse_utils.py

325abb9

docs: cursor.py

539b3dd

docs: connection.py

5ce0fa9

refactor

a9eb4a6

conflict

bbb3378

tina80lvl added 2 commits October 12, 2020 14:02

pull

8dabb7b

refactor

6437b70

IlyaFaer reviewed Oct 12, 2020

View reviewed changes

fixes

8e26153

mf2199 requested changes Oct 15, 2020

View reviewed changes

review fixes

f41acd5

mf2199 reviewed Oct 20, 2020

View reviewed changes

tina80lvl added 8 commits October 21, 2020 16:10

cleanup

17eaefa

review fix

a71ca06

cc

a1ecbec

draft test

b701555

resolving conflicts

50570db

refactor

a1ad37d

revert test

3c3572b

missing parse_values added

dc43995

mf2199 requested changes Oct 30, 2020

View reviewed changes

review fixes

b829809

mf2199 approved these changes Nov 2, 2020

View reviewed changes

tina80lvl and others added 7 commits November 8, 2020 18:43

fixed suggections

c6d924b

Merge branch 'master' into docstr-1

0806ab8

Merge branch 'master' into docstr-1

9e1be73

Rewrap a few docstrings

9aa0c63

merge

467cdaa

fixed conflicts

c4857a4

merge fetch

e04627c

IlyaFaer force-pushed the master branch 3 times, most recently from 1f4932d to 8183247 Compare November 26, 2020 09:52

delete google/cloud/spanner_dbapi

9f286fb

IlyaFaer closed this Feb 1, 2021

		:return: True if all the arguments are in pyformat and have the same
		number of arguments, False otherwise.

docs: missing docstrings for functions & classes #13

docs: missing docstrings for functions & classes #13

Uh oh!

Conversation

tina80lvl commented Oct 1, 2020

Uh oh!

IlyaFaer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mf2199 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!