Sophie

Sophie

distrib > Mageia > 7 > i586 > media > core-release > by-pkgid > be0ec2edf5701fac1f75c3921aad621f > files > 35

python-semantic_version-doc-2.6.0-4.mga7.noarch.rpm


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Interaction with Django &#8212; python-semanticversion 2.6.0 documentation</title>
    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/language_data.js"></script>
    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="ChangeLog" href="changelog.html" />
    <link rel="prev" title="Reference" href="reference.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="changelog.html" title="ChangeLog"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="reference.html" title="Reference"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">python-semanticversion 2.6.0 documentation</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="module-semantic_version.django_fields">
<span id="interaction-with-django"></span><h1>Interaction with Django<a class="headerlink" href="#module-semantic_version.django_fields" title="Permalink to this headline">¶</a></h1>
<p>The <code class="docutils literal notranslate"><span class="pre">python-semanticversion</span></code> package provides two custom fields for Django:</p>
<ul class="simple">
<li><a class="reference internal" href="#semantic_version.django_fields.VersionField" title="semantic_version.django_fields.VersionField"><code class="xref py py-class docutils literal notranslate"><span class="pre">VersionField</span></code></a>: stores a <a class="reference internal" href="reference.html#semantic_version.Version" title="semantic_version.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">semantic_version.Version</span></code></a> object</li>
<li><a class="reference internal" href="#semantic_version.django_fields.SpecField" title="semantic_version.django_fields.SpecField"><code class="xref py py-class docutils literal notranslate"><span class="pre">SpecField</span></code></a>: stores a <a class="reference internal" href="reference.html#semantic_version.Spec" title="semantic_version.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">semantic_version.Spec</span></code></a> object</li>
</ul>
<p>Those fields are <code class="xref py py-class docutils literal notranslate"><span class="pre">django.db.models.CharField</span></code> subclasses,
with their <code class="xref py py-attr docutils literal notranslate"><span class="pre">max_length</span></code> defaulting to 200.</p>
<dl class="class">
<dt id="semantic_version.django_fields.VersionField">
<em class="property">class </em><code class="descclassname">semantic_version.django_fields.</code><code class="descname">VersionField</code><a class="headerlink" href="#semantic_version.django_fields.VersionField" title="Permalink to this definition">¶</a></dt>
<dd><p>Stores a <a class="reference internal" href="reference.html#semantic_version.Version" title="semantic_version.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">semantic_version.Version</span></code></a> as its string representation.</p>
<dl class="attribute">
<dt id="semantic_version.django_fields.VersionField.partial">
<code class="descname">partial</code><a class="headerlink" href="#semantic_version.django_fields.VersionField.partial" title="Permalink to this definition">¶</a></dt>
<dd><p>Boolean; whether <a class="reference internal" href="reference.html#semantic_version.Version.partial" title="semantic_version.Version.partial"><code class="xref py py-attr docutils literal notranslate"><span class="pre">partial</span></code></a> versions are allowed.</p>
</dd></dl>

<dl class="attribute">
<dt id="semantic_version.django_fields.VersionField.coerce">
<code class="descname">coerce</code><a class="headerlink" href="#semantic_version.django_fields.VersionField.coerce" title="Permalink to this definition">¶</a></dt>
<dd><p>Boolean; whether passed in values should be coerced into a semver string
before storing.</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="semantic_version.django_fields.SpecField">
<em class="property">class </em><code class="descclassname">semantic_version.django_fields.</code><code class="descname">SpecField</code><a class="headerlink" href="#semantic_version.django_fields.SpecField" title="Permalink to this definition">¶</a></dt>
<dd><p>Stores a <a class="reference internal" href="reference.html#semantic_version.Spec" title="semantic_version.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">semantic_version.Spec</span></code></a> as its comma-separated string representation.</p>
</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="reference.html"
                        title="previous chapter">Reference</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="changelog.html"
                        title="next chapter">ChangeLog</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/django.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    </div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="changelog.html" title="ChangeLog"
             >next</a> |</li>
        <li class="right" >
          <a href="reference.html" title="Reference"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">python-semanticversion 2.6.0 documentation</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2012-2014, The python-semanticversion project.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
    </div>
  </body>
</html>