diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-usage.rst | 31 | ||||
| -rw-r--r-- | docs/faq.rst | 5 |
2 files changed, 36 insertions, 0 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst index 2a40cfa..72cb181 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -190,6 +190,37 @@ a project (the previous example used 2 API calls): project = gl.projects.get(1, lazy=True) # no API call project.star() # API call +.. _persist_attributes: + +Persisting local attributes +=========================== + +When methods manipulate an existing object, such as with ``refresh()`` and ``save()``, +the object will only have attributes that were returned by the server. In some cases, +such as when the initial request fetches attributes that are needed later for additional +processing, this may not be desired: + +.. code-block:: python + + project = gl.projects.get(1, statistics=True) + project.statistics + + project.refresh() + project.statistics # AttributeError + +To avoid this, pass ``persist_attributes=True`` to ``refresh()``/``save()`` calls: + +.. code-block:: python + + project = gl.projects.get(1, statistics=True) + project.statistics + + project.refresh(persist_attributes=True) + project.statistics + +The ``persist_attributes`` setting is itself persisted in the object and can be reused +for later ``refresh()`` and ``save()`` calls. + Pagination ========== diff --git a/docs/faq.rst b/docs/faq.rst index fe71198..9e3cca1 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -31,3 +31,8 @@ How can I clone the repository of a project? print(project.attributes) # displays all the attributes git_url = project.ssh_url_to_repo subprocess.call(['git', 'clone', git_url]) + +I get an ``AttributeError`` when accessing attributes after ``save()`` or ``refresh()``. + You are most likely trying to access an attribute that was not returned + by the server on the second request. Use the ``persist_attributes=True`` + argument to override this - see :ref:`persist_attributes`. |