Welcome to django-bittersweet’s documentation!

QuickStart

pip install django-bittersweet

Validated get_or_create

from bittersweet.models import validated_get_or_create

try:
    obj, created = validated_get_or_create(MyModel, key=foo, defaults={'foo': 'bar'})
except ValidationError as exc:
    raise RuntimeError('Cannot create MyModel: %s' % exc)

Templating

Filter: |json

{% load bittersweet_json %}

{{ my_variable|json }}

Filter: get_key

{% load bittersweet_context_utils %}

{{ my_dict|get_key:"title" }}

Tag: {% render_inline %}

{% load bittersweet_render_inline %}

{% render_inline %}
    <b>{{ VARIABLE_WHICH_CONTAINS_TEMPLATE_MARKUP }}</b>
{% end_render_inline }

Tag: {% add_facet %}

{% load bittersweet_querystring %}

<a href="?{% add_facet request.GET "item_type" "book" %}">Books</a>
<a href="?{% add_facet request.GET field_name field_value %}">{{ field_value }}</a>

Tag: {% remove_facet %}

{% load bittersweet_querystring %}

<a href="?{% remove_facet request.GET "item_type" "book" %}">Remove: Books</a>
<a href="?{% remove_facet request.GET field_name field_value %}">Remove: {{ field_value }}</a>

Tag: {% qs_alter %}

{% load bittersweet_querystring %}

Query string provided as QueryDict:

{% qs_alter request.GET foo=bar %}
{% qs_alter request.GET foo=bar baaz=quux %}
{% qs_alter request.GET foo=bar baaz=quux delete:corge %}

Remove one facet from a list:

{% qs_alter request.GET foo=bar baaz=quux delete_value:"facets",value %}

Query string provided as string:

{% qs_alter "foo=baaz" foo=bar %}"

Any query string may be stored in a variable in the local template context by making the last argument “as variable_name”:

{% qs_alter request.GET foo=bar baaz=quux delete:corge as new_qs %}

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/acdha/django-bittersweet/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

bittersweet could always use more documentation, whether as part of the official bittersweet docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/acdha/django-bittersweet/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up django-bittersweet for local development.

  1. Fork the django-bittersweet repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/django-bittersweet.git
    
  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv django-bittersweet
    $ cd bittersweet/
    $ python setup.py develop
    
  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature
    

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 bittersweet tests
    $ python setup.py test
    $ tox
    

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
    
  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/acdha/django-bittersweet/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_validated_get_or_create

Changelog

v1.0.0 (2016-02-29)

  • Initial Release. [Chris Adams]

License

Creative Commons Legal Code

CC0 1.0 Universal

    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
    HEREUNDER.

Statement of Purpose

The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").

Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.

For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.

1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:

  i. the right to reproduce, adapt, distribute, perform, display,
     communicate, and translate a Work;
 ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
     likeness depicted in a Work;
 iv. rights protecting against unfair competition in regards to a Work,
     subject to the limitations in paragraph 4(a), below;
  v. rights protecting the extraction, dissemination, use and reuse of data
     in a Work;
 vi. database rights (such as those arising under Directive 96/9/EC of the
     European Parliament and of the Council of 11 March 1996 on the legal
     protection of databases, and under any national implementation
     thereof, including any amended or successor version of such
     directive); and
vii. other similar, equivalent or corresponding rights throughout the
     world based on applicable law or treaty, and any national
     implementations thereof.

2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.

3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.

4. Limitations and Disclaimers.

 a. No trademark or patent rights held by Affirmer are waived, abandoned,
    surrendered, licensed or otherwise affected by this document.
 b. Affirmer offers the Work as-is and makes no representations or
    warranties of any kind concerning the Work, express, implied,
    statutory or otherwise, including without limitation warranties of
    title, merchantability, fitness for a particular purpose, non
    infringement, or the absence of latent or other defects, accuracy, or
    the present or absence of errors, whether or not discoverable, all to
    the greatest extent permissible under applicable law.
 c. Affirmer disclaims responsibility for clearing rights of other persons
    that may apply to the Work or any use thereof, including without
    limitation any person's Copyright and Related Rights in the Work.
    Further, Affirmer disclaims responsibility for obtaining any necessary
    consents, permissions or other rights required for any use of the
    Work.
 d. Affirmer understands and acknowledges that Creative Commons is not a
    party to this document and has no duty or obligation with respect to
    this CC0 or use of the Work.

Modules

bittersweet.templatetags package

Submodules

bittersweet.templatetags.bittersweet_context_utils module

Utilities for manipulating the current template context

bittersweet.templatetags.bittersweet_context_utils.get_key(dictlike, key)[source]

Filter to return a dictionary value by name

Returns None if the key does not exist so either check or use |default_if_none

Usage:

{{ my_dict|get_key:"the key I want" }}
bittersweet.templatetags.bittersweet_json module
bittersweet.templatetags.bittersweet_json.json(data)[source]

Safely JSON-encode an object

To protect against XSS attacks, HTML special characters (<, >, &) and unicode newlines are replaced by escaped unicode characters. Django does not escape these characters by default.

Output of this method is not marked as HTML safe. If you use it inside an HTML attribute, it must be escaped like regular data:

<div data-user="{{ data|json }}">

If you use it inside a <script> tag, then the output does not need to be escaped, so you can mark it as safe:

<script>
    var user = {{ data|json|safe }};
</script>

Escaped characters taken from Rails json_escape() helper: https://github.com/rails/rails/blob/v4.2.5/activesupport/lib/active_support/core_ext/string/output_safety.rb#L60-L113

bittersweet.templatetags.bittersweet_render_inline module

Render a template variable as Django template source in the current context

class bittersweet.templatetags.bittersweet_render_inline.RenderInlineNode(nodelist)[source]

Bases: django.template.base.Node

render(context)[source]
bittersweet.templatetags.bittersweet_render_inline.render_inline(parser, token)[source]

A template tag which renders its contents as a template using the current context, allowing you to process template code stored in something like gettext blocks, model content, django-flatblocks, etc. as if it was actually in the current template.

Usage:

my_template.html:

{% render_inline %}
<b>{{ VARIABLE_WHICH_CONTAINS_TEMPLATE_MARKUP }}</b>
{% end_render_inline %}

Context:

{'VARIABLE_WHICH_CONTAINS_TEMPLATE_MARKUP': 'Hello {{ CURRENT_USER.name }}'}

Output:

'<b>Hello J. Random User</b>'

Module contents

bittersweet.models module

bittersweet.models.validated_get_or_create(klass, **kwargs)[source]

Similar to get_or_create() but uses the methodical get/save including a full_clean() call to avoid problems with models which have validation requirements which are not completely enforced by the underlying database.

For example, with a django-model-translation we always want to go through the setattr route rather than inserting into the database so translated fields will be mapped according to the active language. This avoids normally impossible situations such as creating a record where title is defined but title_en is not.