Ticket #14183: good_docs.txt

File good_docs.txt, 5.0 KB (added by dariog, 4 years ago)
Line 
1Help on module pydoctest.geotest.models in pydoctest.geotest:
2
3NAME
4    pydoctest.geotest.models - Models to test pydoc.
5
6FILE
7    /home/manolo/sandbox/sprint/trunk/pydoctest/geotest/models.py
8
9DESCRIPTION
10    I'm writing some DocStrings to test pydoc and geodjango.
11
12CLASSES
13    django.db.models.base.Model(__builtin__.object)
14        TestGeoModel
15   
16    class TestGeoModel(django.db.models.base.Model)
17     |  This is a geographic model.
18     | 
19     |  It is very complicated, thus the enormously long docstring.
20     | 
21     |  Method resolution order:
22     |      TestGeoModel
23     |      django.db.models.base.Model
24     |      __builtin__.object
25     | 
26     |  Methods defined here:
27     | 
28     |  __unicode__(self)
29     |      Get a unicode representation of this object (it's just its name).
30     | 
31     |  ----------------------------------------------------------------------
32     |  Data and other attributes defined here:
33     | 
34     |  DoesNotExist = <class 'pydoctest.geotest.models.DoesNotExist'>
35     | 
36     | 
37     |  MultipleObjectsReturned = <class 'pydoctest.geotest.models.MultipleObj...
38     | 
39     | 
40     |  objects = <django.db.models.manager.Manager object at 0x93f252c>
41     | 
42     |  ----------------------------------------------------------------------
43     |  Methods inherited from django.db.models.base.Model:
44     | 
45     |  __eq__(self, other)
46     | 
47     |  __hash__(self)
48     | 
49     |  __init__(self, *args, **kwargs)
50     | 
51     |  __ne__(self, other)
52     | 
53     |  __reduce__(self)
54     |      Provide pickling support. Normally, this just dispatches to Python's
55     |      standard handling. However, for models with deferred field loading, we
56     |      need to do things manually, as they're dynamically created classes and
57     |      only module-level classes can be pickled by the default path.
58     | 
59     |  __repr__(self)
60     | 
61     |  __str__(self)
62     | 
63     |  clean(self)
64     |      Hook for doing any extra model-wide validation after clean() has been
65     |      called on every field by self.clean_fields. Any ValidationError raised
66     |      by this method will not be associated with a particular field; it will
67     |      have a special-case association with the field defined by NON_FIELD_ERRORS.
68     | 
69     |  clean_fields(self, exclude=None)
70     |      Cleans all fields and raises a ValidationError containing message_dict
71     |      of all validation errors if any occur.
72     | 
73     |  date_error_message(self, lookup_type, field, unique_for)
74     | 
75     |  delete(self, using=None)
76     | 
77     |  full_clean(self, exclude=None)
78     |      Calls clean_fields, clean, and validate_unique, on the model,
79     |      and raises a ``ValidationError`` for any errors that occured.
80     | 
81     |  prepare_database_save(self, unused)
82     | 
83     |  save(self, force_insert=False, force_update=False, using=None)
84     |      Saves the current instance. Override this in a subclass if you want to
85     |      control the saving process.
86     |     
87     |      The 'force_insert' and 'force_update' parameters can be used to insist
88     |      that the "save" must be an SQL insert or update (or equivalent for
89     |      non-SQL backends), respectively. Normally, they should not be set.
90     | 
91     |  save_base(self, raw=False, cls=None, origin=None, force_insert=False, force_update=False, using=None)
92     |      Does the heavy-lifting involved in saving. Subclasses shouldn't need to
93     |      override this method. It's separate from save() in order to hide the
94     |      need for overrides of save() to pass around internal-only parameters
95     |      ('raw', 'cls', and 'origin').
96     | 
97     |  serializable_value(self, field_name)
98     |      Returns the value of the field name for this instance. If the field is
99     |      a foreign key, returns the id value, instead of the object. If there's
100     |      no Field object with this name on the model, the model attribute's
101     |      value is returned directly.
102     |     
103     |      Used to serialize a field's value (in the serializer, or form output,
104     |      for example). Normally, you would just access the attribute directly
105     |      and not use this method.
106     | 
107     |  unique_error_message(self, model_class, unique_check)
108     | 
109     |  validate_unique(self, exclude=None)
110     |      Checks unique constraints on the model and raises ``ValidationError``
111     |      if any failed.
112     | 
113     |  ----------------------------------------------------------------------
114     |  Data descriptors inherited from django.db.models.base.Model:
115     | 
116     |  __dict__
117     |      dictionary for instance variables (if defined)
118     | 
119     |  __weakref__
120     |      list of weak references to the object (if defined)
121     | 
122     |  pk
123     | 
124     |  ----------------------------------------------------------------------
125     |  Data and other attributes inherited from django.db.models.base.Model:
126     | 
127     |  __metaclass__ = <class 'django.db.models.base.ModelBase'>
128     |      Metaclass for all models.
129
130
Back to Top