easy_thumbnails.alias: 46 total statements, 0.0% covered

Generated: Wed 2013-03-13 10:33 CET

Source file: /media/Envs/Envs/filer-gallery/lib/python2.7/site-packages/easy_thumbnails/alias.py

Stats: 0 executed, 45 missed, 1 excluded, 77 ignored

1. from easy_thumbnails.conf import settings
4. class Aliases(object):
5. """
6. A container which stores and retrieves named easy-thumbnail options
7. dictionaries.
8. """
10. def __init__(self, populate_from_settings=True):
11. """
12. Initialize the Aliases object.
14. :param populate_from_settings: If ``True`` (default) then populate the
15. initial aliases from settings. See :meth:`populate_from_settings`.
16. """
17. self._aliases = {}
18. if populate_from_settings:
19. self.populate_from_settings()
21. def populate_from_settings(self):
22. """
23. Populate the aliases from the ``THUMBNAIL_ALIASES`` setting.
24. """
25. settings_aliases = settings.THUMBNAIL_ALIASES
26. if settings_aliases:
27. for target, aliases in settings_aliases.items():
28. target_aliases = self._aliases.setdefault(target, {})
29. target_aliases.update(aliases)
31. def set(self, alias, options, target=None):
32. """
33. Add an alias.
35. :param alias: The name of the alias to add.
36. :param options: The easy-thumbnails options dictonary for this alias
37. (should include ``size``).
38. :param target: A field, model, or app to limit this alias to
39. (optional).
40. """
41. target = self._coerce_target(target) or ''
42. target_aliases = self._aliases.setdefault(target, {})
43. target_aliases[alias] = options
45. def get(self, alias, target=None):
46. """
47. Get a dictionary of aliased options.
49. :param alias: The name of the aliased options.
50. :param target: Get alias for this specific target (optional).
52. If no matching alias is found, returns ``None``.
53. """
54. for target_part in reversed(list(self._get_targets(target))):
55. options = self._get(target_part, alias)
56. if options:
57. return options
58. return self._get('', alias)
60. def all(self, target=None, include_global=True):
61. """
62. Get a dictionary of all aliases and their options.
64. :param target: Include aliases for this specific field, model or app
65. (optional).
66. :param include_global: Include all non target-specific aliases
67. (default ``True``).
69. For example::
71. >>> aliases.all(target='my_app.MyModel')
72. {'small': {'size': (100, 100)}, 'large': {'size': (400, 400)}}
73. """
74. aliases = {}
75. for target_part in self._get_targets(target, include_global):
76. aliases.update(self._aliases.get(target_part, {}))
77. return aliases
79. def _get(self, target, alias):
80. """
81. Internal method to get a specific alias.
82. """
83. if target not in self._aliases:
84. return
85. return self._aliases[target].get(alias)
87. def _get_targets(self, target, include_global=True):
88. """
89. Internal iterator to split up a complete target into the possible parts
90. it may match.
92. For example::
94. >>> list(aliases._get_targets('my_app.MyModel.somefield'))
95. ['', 'my_app', 'my_app.MyModel', 'my_app.MyModel.somefield']
96. """
97. target = self._coerce_target(target)
98. if include_global:
99. yield ''
100. if not target:
101. return
102. target_bits = target.split('.')
103. for i in range(len(target_bits)):
104. yield '.'.join(target_bits[:i + 1])
106. def _coerce_target(self, target):
107. """
108. Internal method to coerce a target to a string.
110. The assumption is that if it is not ``None`` and not a string, it is
111. a Django ``FieldFile`` object.
112. """
113. if not target or isinstance(target, basestring):
114. return target
115. model = target.instance.__class__
116. return '%s.%s.%s' % (
117. model._meta.app_label,
118. model.__name__,
119. target.field.name,
120. )
123. aliases = Aliases()