Added simple docs to examples, all added examples used tested

tortoise · Oct 10, 2019 · f428a68 · f428a68
1 parent 6675b54
commit f428a68
Show file tree

Hide file tree

Showing 11 changed files with 111 additions and 14 deletions.
diff --git a/.pylintrc b/.pylintrc
@@ -54,7 +54,7 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-disable=C0330,C0412,W0212,W0613,R0902,R0903,
+disable=C0330,C0412,W0212,W0613,R0902,R0903,R0904,
         # tune down below here
         C0103,C0111,R1702,R0912,R0913,R0914,R0915
 

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,7 +4,7 @@ Changelog
 =========
 0.14.0
 ------
-.. warning::
+.. caution::
    **This release drops support of Python 3.5:**
 
    Tortoise ORM now requires a minimum of CPython 3.6 or PyPy3.6-7.1

diff --git a/docs/conf.py b/docs/conf.py
@@ -43,9 +43,9 @@ def __getattr__(cls, name):
 # -- Project information -----------------------------------------------------
 
 
-project = 'Tortoise'
-copyright = '2018, Andrey Bondar'  # pylint: disable=W0622
-author = 'Andrey Bondar'
+project = 'Tortoise ORM'
+copyright = '2018-2019, Andrey Bondar & Nickolas Grigoriadis'  # pylint: disable=W0622
+author = 'Andrey Bondar & Nickolas Grigoriadis'
 
 
 def get_version():

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,95 @@
+.. _examples:
+
+========
+Examples
+========
+
+
+.. rst-class:: html-toggle
+
+.. _example_basic:
+
+Basic
+=====
+.. literalinclude::  ../examples/basic.py
+
+
+.. rst-class:: html-toggle
+
+.. _example_basic_comments:
+
+Basic with comments
+===================
+.. literalinclude::  ../examples/basic_comments.py
+
+
+.. rst-class:: html-toggle
+
+.. _example_prefetching:
+
+Prefetching
+===========
+.. literalinclude::  ../examples/complex_prefetching.py
+
+
+.. rst-class:: html-toggle
+
+.. _example_transactions:
+
+Transactions
+============
+.. literalinclude::  ../examples/transactions.py
+
+
+.. rst-class:: html-toggle
+
+.. _example_aggregation:
+
+Aggregation
+===========
+.. literalinclude::  ../examples/aggregation.py
+
+
+.. rst-class:: html-toggle
+
+.. _example_schema_create:
+
+Schema creation
+===============
+.. literalinclude::  ../examples/schema_create.py
+
+
+.. rst-class:: html-toggle
+
+.. _example_two_databases:
+
+Two Databases
+=============
+.. literalinclude::  ../examples/two_databases.py
+
+
+.. rst-class:: html-toggle
+
+.. _example_filtering:
+
+Filtering
+=========
+.. literalinclude::  ../examples/complex_filtering.py
+
+
+.. rst-class:: html-toggle
+
+.. _example_relations:
+
+Relations
+=========
+.. literalinclude::  ../examples/relations.py
+
+
+.. rst-class:: html-toggle
+
+.. _example_relations_recursive:
+
+Schema creation
+===============
+.. literalinclude::  ../examples/relations_recursive.py
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -155,4 +155,4 @@ After that you can start using your models:
 
 .. note::
     You can read more examples (including transactions, several databases and a little more complex querying) in
-    `examples <https://github.com/tortoise/tortoise-orm/tree/master/examples>`_ directory of project
+    :ref:`examples`
diff --git a/docs/query.rst b/docs/query.rst
@@ -214,6 +214,4 @@ Sometimes it is required to fetch only certain related records. You can achieve
         Prefetch('events', queryset=Event.filter(name='First'))
     ).first()
 
-You can view full example here:  ``examples/complex_prefetching.py``
-
-.. literalinclude::  ../examples/complex_prefetching.py
+You can view full example here:  :ref:`example_prefetching`
diff --git a/docs/toc.rst b/docs/toc.rst
@@ -8,6 +8,7 @@ Table Of Contents
    index
    getting_started
    reference
+   examples
    contrib
    CHANGELOG
    roadmap

diff --git a/examples/basic.py b/examples/basic.py
@@ -25,10 +25,13 @@ async def run():
     await Event.filter(id=event.id).update(name="Updated name")
 
     print(await Event.filter(name="Updated name").first())
+    # >>> Updated name
 
     await Event(name="Test 2").save()
     print(await Event.all().values_list("id", flat=True))
+    # >>> [1, 2]
     print(await Event.all().values("id", "name"))
+    # >>> [{'id': 1, 'name': 'Updated name'}, {'id': 2, 'name': 'Test 2'}]
 
 
 if __name__ == "__main__":

diff --git a/examples/schema_create.py b/examples/schema_create.py
@@ -8,7 +8,7 @@
 
 class Tournament(Model):
     id = fields.IntField(pk=True)
-    name = fields.TextField(description="Tournament name", index=True)
+    name = fields.CharField(max_length=255, description="Tournament name", index=True)
     created = fields.DatetimeField(auto_now_add=True, description="Created datetime")
 
     class Meta:
@@ -17,7 +17,7 @@ class Meta:
 
 class Event(Model):
     id = fields.IntField(pk=True, description="Event ID")
-    name = fields.TextField(unique=True)
+    name = fields.CharField(max_length=255, unique=True)
     tournament = fields.ForeignKeyField(
         "models.Tournament", related_name="events", description="FK to tournament"
     )

diff --git a/tortoise/__init__.py b/tortoise/__init__.py
@@ -655,4 +655,4 @@ async def do_stuff():
         loop.run_until_complete(Tortoise.close_connections())
 
 
-__version__ = "0.14.0dev"
+__version__ = "0.14.dev0"
diff --git a/tortoise/queryset.py b/tortoise/queryset.py
@@ -36,12 +36,12 @@
 
 
 class QuerySetIterable(Protocol[T_co]):
-    ...
+    ...  # pylint: disable=W0104
 
 
 class QuerySetSingle(Protocol[T_co]):
     def __await__(self) -> Generator[Any, None, T_co]:
-        ...
+        ...  # pylint: disable=W0104
 
 
 class AwaitableQuery(QuerySetIterable[MODEL]):