├── .gitignore
├── .pylintrc
├── .travis.yml
├── CONTRIBUTING.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── rest_framework_serializer_field_permissions
├── __init__.py
├── fields.py
├── permissions.py
├── serializers.py
├── test_app
│ ├── __init__.py
│ └── models.py
└── tests
│ ├── __init__.py
│ ├── runtests.py
│ └── tests.py
├── setup.py
└── tox.ini
/.gitignore:
--------------------------------------------------------------------------------
1 | *.pyc
2 | .*swp
3 | *~
4 | .idea/
5 | .tox/
6 | dist/
7 | *.egg-info/
8 | .coverage
9 |
10 |
--------------------------------------------------------------------------------
/.pylintrc:
--------------------------------------------------------------------------------
1 | [MASTER]
2 |
3 | # Specify a configuration file.
4 | #rcfile=
5 |
6 | # Python code to execute, usually for sys.path manipulation such as
7 | # pygtk.require().
8 | #init-hook=
9 |
10 | # Profiled execution.
11 | profile=no
12 |
13 | # Add files or directories to the blacklist. They should be base names, not
14 | # paths.
15 | ignore=CVS, dist, *.egg-info, docs, tests, test_app
16 |
17 | # Pickle collected data for later comparisons.
18 | persistent=yes
19 |
20 | # List of plugins (as comma separated values of python modules names) to load,
21 | # usually to register additional checkers.
22 | load-plugins=
23 |
24 | # DEPRECATED
25 | include-ids=no
26 |
27 | # DEPRECATED
28 | symbols=no
29 |
30 | # Allow loading of arbitrary C extensions. Extensions are imported into the
31 | # active Python interpreter and may run arbitrary code.
32 | unsafe-load-any-extension=no
33 |
34 | # A comma-separated list of package or module names from where C extensions may
35 | # be loaded. Extensions are loading into the active Python interpreter and may
36 | # run arbitrary code
37 | extension-pkg-whitelist=
38 |
39 |
40 | [MESSAGES CONTROL]
41 |
42 | # Enable the message, report, category or checker with the given id(s). You can
43 | # either give multiple identifier separated by comma (,) or put this option
44 | # multiple time. See also the "--disable" option for examples.
45 | #enable=
46 |
47 | # Disable the message, report, category or checker with the given id(s). You
48 | # can either give multiple identifiers separated by comma (,) or put this
49 | # option multiple times (only on the command line, not in the configuration
50 | # file where it should appear only once).You can also use "--disable=all" to
51 | # disable everything first and then reenable specific checks. For example, if
52 | # you want to run only the similarities checker, you can use "--disable=all
53 | # --enable=similarities". If you want to run only the classes checker, but have
54 | # no Warning level messages displayed, use"--disable=all --enable=classes
55 | # --disable=W"
56 | disable=E1101, F0401
57 |
58 |
59 | [REPORTS]
60 |
61 | # Set the output format. Available formats are text, parseable, colorized, msvs
62 | # (visual studio) and html. You can also give a reporter class, eg
63 | # mypackage.mymodule.MyReporterClass.
64 | output-format=text
65 |
66 | # Put messages in a separate file for each module / package specified on the
67 | # command line instead of printing them on stdout. Reports (if any) will be
68 | # written in a file name "pylint_global.[txt|html]".
69 | files-output=no
70 |
71 | # Tells whether to display a full report or only the messages
72 | reports=yes
73 |
74 | # Python expression which should return a note less than 10 (10 is the highest
75 | # note). You have access to the variables errors warning, statement which
76 | # respectively contain the number of errors / warnings messages and the total
77 | # number of statements analyzed. This is used by the global evaluation report
78 | # (RP0004).
79 | evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
80 |
81 | # Add a comment according to your evaluation note. This is used by the global
82 | # evaluation report (RP0004).
83 | comment=no
84 |
85 | # Template used to display messages. This is a python new-style format string
86 | # used to format the message information. See doc for all details
87 | #msg-template=
88 |
89 |
90 | [LOGGING]
91 |
92 | # Logging modules to check that the string format arguments are in logging
93 | # function parameter format
94 | logging-modules=logging
95 |
96 |
97 | [SIMILARITIES]
98 |
99 | # Minimum lines number of a similarity.
100 | min-similarity-lines=4
101 |
102 | # Ignore comments when computing similarities.
103 | ignore-comments=yes
104 |
105 | # Ignore docstrings when computing similarities.
106 | ignore-docstrings=yes
107 |
108 | # Ignore imports when computing similarities.
109 | ignore-imports=no
110 |
111 |
112 | [TYPECHECK]
113 |
114 | # Tells whether missing members accessed in mixin class should be ignored. A
115 | # mixin class is detected if its name ends with "mixin" (case insensitive).
116 | ignore-mixin-members=yes
117 |
118 | # List of module names for which member attributes should not be checked
119 | # (useful for modules/projects where namespaces are manipulated during runtime
120 | # and thus existing member attributes cannot be deduced by static analysis
121 | ignored-modules=
122 |
123 | # List of classes names for which member attributes should not be checked
124 | # (useful for classes with attributes dynamically set).
125 | ignored-classes=SQLObject
126 |
127 | # When zope mode is activated, add a predefined set of Zope acquired attributes
128 | # to generated-members.
129 | zope=no
130 |
131 | # List of members which are set dynamically and missed by pylint inference
132 | # system, and so shouldn't trigger E0201 when accessed. Python regular
133 | # expressions are accepted.
134 | generated-members=REQUEST,acl_users,aq_parent
135 |
136 |
137 | [VARIABLES]
138 |
139 | # Tells whether we should check for unused import in __init__ files.
140 | init-import=no
141 |
142 | # A regular expression matching the name of dummy variables (i.e. expectedly
143 | # not used).
144 | dummy-variables-rgx=_$|dummy
145 |
146 | # List of additional names supposed to be defined in builtins. Remember that
147 | # you should avoid to define new builtins when possible.
148 | additional-builtins=
149 |
150 |
151 | [BASIC]
152 |
153 | # Required attributes for module, separated by a comma
154 | required-attributes=
155 |
156 | # List of builtins function names that should not be used, separated by a comma
157 | bad-functions=map,filter,apply,input,file
158 |
159 | # Good variable names which should always be accepted, separated by a comma
160 | good-names=i,j,k,ex,Run,_
161 |
162 | # Bad variable names which should always be refused, separated by a comma
163 | bad-names=foo,bar,baz,toto,tutu,tata
164 |
165 | # Colon-delimited sets of names that determine each other's naming style when
166 | # the name regexes allow several styles.
167 | name-group=
168 |
169 | # Include a hint for the correct naming format with invalid-name
170 | include-naming-hint=no
171 |
172 | # Regular expression matching correct function names
173 | function-rgx=[a-z_][a-z0-9_]{2,30}$
174 |
175 | # Naming hint for function names
176 | function-name-hint=[a-z_][a-z0-9_]{2,30}$
177 |
178 | # Regular expression matching correct variable names
179 | variable-rgx=[a-z_][a-z0-9_]{2,30}$
180 |
181 | # Naming hint for variable names
182 | variable-name-hint=[a-z_][a-z0-9_]{2,30}$
183 |
184 | # Regular expression matching correct constant names
185 | const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
186 |
187 | # Naming hint for constant names
188 | const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
189 |
190 | # Regular expression matching correct attribute names
191 | attr-rgx=[a-z_][a-z0-9_]{2,30}$
192 |
193 | # Naming hint for attribute names
194 | attr-name-hint=[a-z_][a-z0-9_]{2,30}$
195 |
196 | # Regular expression matching correct argument names
197 | argument-rgx=[a-z_][a-z0-9_]{2,30}$
198 |
199 | # Naming hint for argument names
200 | argument-name-hint=[a-z_][a-z0-9_]{2,30}$
201 |
202 | # Regular expression matching correct class attribute names
203 | class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
204 |
205 | # Naming hint for class attribute names
206 | class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
207 |
208 | # Regular expression matching correct inline iteration names
209 | inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
210 |
211 | # Naming hint for inline iteration names
212 | inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
213 |
214 | # Regular expression matching correct class names
215 | class-rgx=[A-Z_][a-zA-Z0-9]+$
216 |
217 | # Naming hint for class names
218 | class-name-hint=[A-Z_][a-zA-Z0-9]+$
219 |
220 | # Regular expression matching correct module names
221 | module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
222 |
223 | # Naming hint for module names
224 | module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
225 |
226 | # Regular expression matching correct method names
227 | method-rgx=[a-z_][a-z0-9_]{2,30}$
228 |
229 | # Naming hint for method names
230 | method-name-hint=[a-z_][a-z0-9_]{2,30}$
231 |
232 | # Regular expression which should only match function or class names that do
233 | # not require a docstring.
234 | no-docstring-rgx=__.*__
235 |
236 | # Minimum line length for functions/classes that require docstrings, shorter
237 | # ones are exempt.
238 | docstring-min-length=-1
239 |
240 |
241 | [MISCELLANEOUS]
242 |
243 | # List of note tags to take in consideration, separated by a comma.
244 | notes=FIXME,XXX,TODO
245 |
246 |
247 | [FORMAT]
248 |
249 | # Maximum number of characters on a single line.
250 | max-line-length=100
251 |
252 | # Regexp for a line that is allowed to be longer than the limit.
253 | ignore-long-lines=^\s*(# )??$
254 |
255 | # Allow the body of an if to be on the same line as the test if there is no
256 | # else.
257 | single-line-if-stmt=no
258 |
259 | # List of optional constructs for which whitespace checking is disabled
260 | no-space-check=
261 |
262 | # Maximum number of lines in a module
263 | max-module-lines=1000
264 |
265 | # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
266 | # tab).
267 | indent-string=' '
268 |
269 | # Number of spaces of indent required inside a hanging or continued line.
270 | indent-after-paren=4
271 |
272 |
273 | [DESIGN]
274 |
275 | # Maximum number of arguments for function / method
276 | max-args=5
277 |
278 | # Argument names that match this expression will be ignored. Default to name
279 | # with leading underscore
280 | ignored-argument-names=_.*
281 |
282 | # Maximum number of locals for function / method body
283 | max-locals=15
284 |
285 | # Maximum number of return / yield for function / method body
286 | max-returns=6
287 |
288 | # Maximum number of branch for function / method body
289 | max-branches=12
290 |
291 | # Maximum number of statements in function / method body
292 | max-statements=50
293 |
294 | # Maximum number of parents for a class (see R0901).
295 | max-parents=7
296 |
297 | # Maximum number of attributes for a class (see R0902).
298 | max-attributes=7
299 |
300 | # Minimum number of public methods for a class (see R0903).
301 | min-public-methods=2
302 |
303 | # Maximum number of public methods for a class (see R0904).
304 | max-public-methods=20
305 |
306 |
307 | [IMPORTS]
308 |
309 | # Deprecated modules which should not be used, separated by a comma
310 | deprecated-modules=regsub,TERMIOS,Bastion,rexec
311 |
312 | # Create a graph of every (i.e. internal and external) dependencies in the
313 | # given file (report RP0402 must not be disabled)
314 | import-graph=
315 |
316 | # Create a graph of external dependencies in the given file (report RP0402 must
317 | # not be disabled)
318 | ext-import-graph=
319 |
320 | # Create a graph of internal dependencies in the given file (report RP0402 must
321 | # not be disabled)
322 | int-import-graph=
323 |
324 |
325 | [CLASSES]
326 |
327 | # List of interface methods to ignore, separated by a comma. This is used for
328 | # instance to not check methods defines in Zope's Interface base class.
329 | ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
330 |
331 | # List of method names used to declare (i.e. assign) instance attributes.
332 | defining-attr-methods=__init__,__new__,setUp
333 |
334 | # List of valid names for the first argument in a class method.
335 | valid-classmethod-first-arg=cls
336 |
337 | # List of valid names for the first argument in a metaclass class method.
338 | valid-metaclass-classmethod-first-arg=mcs
339 |
340 |
341 | [EXCEPTIONS]
342 |
343 | # Exceptions that will emit a warning when being caught. Defaults to
344 | # "Exception"
345 | overgeneral-exceptions=Exception
346 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: python
2 |
3 | matrix:
4 | include:
5 | - python: 3.7
6 | dist: xenial
7 | sudo: true
8 | env:
9 | - TOX_ENV=py37-django3.0-drf3.11
10 | - python: 3.7
11 | dist: xenial
12 | sudo: true
13 | env:
14 | - TOX_ENV=py37-django2.2-drf3.11
15 | fast_finish: true
16 |
17 | install:
18 | - pip install tox
19 |
20 | script:
21 | - tox -e $TOX_ENV
22 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | This document contains technical instructions for how to develop this package. See [the readme](README.md) for a description of what kinds of changes might be accepted.
4 |
5 | ## Installing Development Requirements
6 |
7 | First, create a virtual environment with the version of Python specified in [the tox file](tox.ini).
8 |
9 | Then, install the development requirements:
10 |
11 | ```bash
12 | $ pip install -e .[dev]
13 | ```
14 |
15 | ## Running Tests
16 |
17 | Use tox to run tests against all supported versions:
18 |
19 | ```bash
20 | $ tox
21 | ```
22 |
23 | ## Publishing the Library
24 |
25 | Make sure that you've updated the library version in [`setup.py`](setup.py). Then build and publish the library:
26 |
27 | ```bash
28 | $ python setup.py sdist
29 | $ python -m twine upload dist/*
30 | ```
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
676 |
--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
1 | include LICENSE
2 | include README.md
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [](https://codeclimate.com/github/InterSIS/django-rest-serializer-field-permissions)
2 | [](https://coveralls.io/github/InterSIS/django-rest-serializer-field-permissions?branch=master)
3 | [](http://badge.fury.io/py/django-rest-serializer-field-permissions)
4 |
5 | django-rest-serializer-field-permissions
6 | =============
7 |
8 | Add field-by-field permission classes to your serializer fields that look like this:
9 |
10 | ```python
11 | class PersonSerializer(FieldPermissionSerializerMixin, LookupModelSerializer):
12 |
13 | # Only allow authenticated users to retrieve family and given names
14 | family_names = serializers.CharField(permission_classes=(IsAuthenticated(), ))
15 | given_names = serializers.CharField(permission_classes=(IsAuthenticated(), ))
16 |
17 | # Allow all users to retrieve nick name
18 | nick_name = serializers.CharField(permission_classes=(AllowAll(), ))
19 |
20 | ```
21 |
22 | Getting Involved, New Features, Etc.
23 | ------------------------------------
24 |
25 | This project is in *maintenance mode*. I can offer the following support/upgrades:
26 | * Ongoing compatibility with DRF version 3.
27 | * Ongoing compatibility with Django version 3.
28 | * If future major versions of Django and DRF are roughly compatible with this plugin, then I hope to offer ongoing support for those as well.
29 | * Adding new fields to the library's drop-in replacements as Django adds new fields.
30 |
31 | Several people have offered really great ideas for how to improve this library. Unfortunately, I don't use this library regularly myself and it takes me a day or two to spin myself back up on it to the point where I can safely and responsibly consider the impacts of proposed changes. And at this time, I'm unable to fulfill that responsibility.
32 |
33 | If you have a change/issue that falls under one of the bullet points above, please feel free to raise it in the issue tracker!
34 |
35 | Complete Tutorial
36 | ----------------
37 |
38 | This example builds on the example Django REST Framework API in the [DRF 3.9 documentation](https://github.com/encode/django-rest-framework/tree/3.9.x#example). Please make sure that you have completed that tutorial before beginning this one.
39 |
40 | Install this module into your environment:
41 |
42 | ```
43 | $ pip install django-rest-serializer-field-permissions~=3.0
44 | ```
45 |
46 | Install this module into Django by adding it to your `INSTALLED_APPS`.
47 | ```python
48 | INSTALLED_APPS = (
49 | # ...
50 | 'rest_framework_serializer_field_permissions',
51 | # ...
52 | )
53 | ```
54 |
55 |
56 | Now you can add retrieve permissions to individual fields. You must import the modules and classes shown below, mix `FieldPermissionSerializerMixin` as the **leftmost** parent to your serializers, and then define your fields using the provided drop-in field classes.
57 |
58 | For example, modify the root `urls.py` you created in the DRF tutorial with the following code:
59 |
60 | ```python
61 | from django.conf.urls import url, include
62 | from django.contrib.auth.models import User
63 | from rest_framework import routers, serializers, viewsets
64 |
65 | from rest_framework_serializer_field_permissions import fields # <--
66 | from rest_framework_serializer_field_permissions.serializers import FieldPermissionSerializerMixin # <--
67 | from rest_framework_serializer_field_permissions.permissions import IsAuthenticated # <--
68 |
69 | # Serializers define the API representation.
70 | class UserSerializer(FieldPermissionSerializerMixin, serializers.HyperlinkedModelSerializer): # <--
71 | class Meta:
72 | model = User
73 | fields = ('url', 'username', 'email', 'is_staff')
74 |
75 | email = fields.EmailField(permission_classes=(IsAuthenticated(), )) # <--
76 |
77 | # ViewSets define the view behavior.
78 | class UserViewSet(viewsets.ModelViewSet):
79 | queryset = User.objects.all()
80 | serializer_class = UserSerializer
81 |
82 | # Routers provide an easy way of automatically determining the URL conf.
83 | router = routers.DefaultRouter()
84 | router.register(r'users', UserViewSet)
85 |
86 | # Wire up our API using automatic URL routing.
87 | # Additionally, we include login URLs for the browsable API.
88 | urlpatterns = [
89 | url(r'^', include(router.urls)),
90 | url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
91 | ]
92 |
93 | ```
94 |
95 | Now, only authenticated users will be able to retrieve your users' emails. You can confirm this by creating a superuser account, if you haven't already, and visiting [http://localhost:8000/users/](http://localhost:8000/users) as both an authenticated user and an unauthenticated visitor.
96 |
97 | Alternately, you could have restricted retrieve access to the `username` field with the code:
98 |
99 | ```python
100 | username = fields.CharField(permission_classes=(IsAuthenticated(), ))
101 | ```
102 |
103 | You can define your own permissions classes that operate on any aspect of the incoming `request`, and you can specify multiple r`permission_classes` on a field: all provided permissions must be satisfied for the visitor to retrieve the given field.
104 |
105 | Use
106 | ---
107 |
108 | ### Installation
109 |
110 | Install the module in your Python distribution or virtualenv:
111 |
112 | $ pip install django-rest-serializer-field-permissions
113 |
114 | Add the application to your `INSTALLED_APPS`:
115 |
116 | ```python
117 | INSTALLED_APPS = (
118 | ...
119 | 'rest_framework_serializer_field_permissions',
120 | ...
121 | )
122 | ```
123 |
124 | ### Adding Permissions
125 |
126 | In your serializers, mix `FieldPermissionSerializerMixin` into your serializer classes, as the left-most parent. The fields
127 | provided by `rest_framework_serializer_field_permissions.fields` accept `permission_classes` which operate in typical
128 | DRF fashion:
129 |
130 | ```python
131 | from rest_framework import serializers
132 |
133 | from rest_framework_serializer_field_permissions import fields
134 | from rest_framework_serializer_field_permissions.serializers import FieldPermissionSerializerMixin
135 | from rest_framework_serializer_field_permissions.permissions import IsAuthenticated
136 |
137 | class UserSerializer(FieldPermissionSerializerMixin, serializers.HyperlinkedModelSerializer):
138 | class Meta:
139 | model = User
140 | fields = ('url', 'username', 'email', 'is_staff')
141 |
142 | email = fields.EmailField(permission_classes=(IsAuthenticated(), ))
143 |
144 | ```
145 |
146 | The `FieldPermissionSerializerMixin` may be mixed with any DRF serializer class, not just `ModelSerializer`.
147 |
148 | You can write your own permission classes by sub-classing `BaseFieldPermission` in `permissions.py`.
149 |
150 | How it Works
151 | ------------
152 |
153 | The `FieldPermissionSerializerMixin` provides its own `fields` property, which DRF serializers call to get a list
154 | of their own fields. The amended `fields` property checks for permission-bearing fields, forces them to check their
155 | permissions against the request, and scrubs from the return any fields which fail their permission checks.
156 |
157 | Compatibility
158 | -------------
159 |
160 | This package is tested for compatibility against the following software versions:
161 |
162 | * Django Rest Framework 3.14.0
163 | * Django 3.2, 4.2
164 | * Python 3.8
165 |
166 | This package may incidentally be compatible with other similar versions of the above software. See tox.ini for specific minor versions tested.
167 |
168 | Additional Requirements
169 | -----------------------
170 |
171 | None
172 |
173 |
--------------------------------------------------------------------------------
/rest_framework_serializer_field_permissions/__init__.py:
--------------------------------------------------------------------------------
1 | """
2 | Add permission classes to your Django Rest Framework serializer fields.
3 | """
4 |
--------------------------------------------------------------------------------
/rest_framework_serializer_field_permissions/fields.py:
--------------------------------------------------------------------------------
1 | """
2 | Drop in replacements for DRF's fields. Use as follows:
3 |
4 | from rest_framework_serializer_field_permissions import fields
5 |
6 | class PersonSerializer(FieldPermissionSerializerMixin, serializers.ModelSerializer):
7 |
8 | family_names = fields.CharField(permission_classes=(IsAuthenticated(), ))
9 | given_names = fields.CharField(permission_classes=(IsAuthenticated(), ))
10 | nick_name = fields.CharField(permission_classes=(AllowAny(), ))
11 | """
12 | import copy
13 | import inspect
14 |
15 | from rest_framework import fields
16 | from rest_framework.serializers import LIST_SERIALIZER_KWARGS, ListSerializer
17 |
18 |
19 | class PermissionMixin(object):
20 | """
21 | Mixin for DRF's field objects, to make them permission capable.
22 | """
23 | def __init__(self, *args, **kwargs):
24 | permission_classes = kwargs.pop("permission_classes", ())
25 |
26 | super(PermissionMixin, self).__init__(*args, **kwargs)
27 | self.permission_classes = permission_classes
28 |
29 | def check_permission(self, request):
30 | """
31 | Check this field's permissions to determine whether or not it may be
32 | shown.
33 | """
34 | return all((permission.has_permission(request) for permission in self.permission_classes))
35 |
36 |
37 | # TODO: docstring
38 | # pylint: disable=missing-docstring
39 | class SerializerPermissionMixin(PermissionMixin):
40 |
41 | # TODO: diagnost/address abstract-method issue
42 | # pylint: disable=abstract-method
43 | class PermissionListSerializer(ListSerializer):
44 |
45 | def __init__(self, *args, **kwargs):
46 | self.child = kwargs.pop('child', copy.deepcopy(self.child))
47 |
48 | self.permission_classes = self.child.permission_classes
49 | self.check_permission = self.child.check_permission
50 |
51 | self.allow_empty = kwargs.pop('allow_empty', True)
52 |
53 | assert self.child is not None, '`child` is a required argument.'
54 | assert not inspect.isclass(self.child), '`child` has not been instantiated.'
55 |
56 | # TODO: diagnose/address bad-super-call issue
57 | # pylint: disable=bad-super-call
58 | super(ListSerializer, self).__init__(*args, **kwargs)
59 |
60 | self.child.bind(field_name='', parent=self)
61 |
62 | @classmethod
63 | def many_init(cls, *args, **kwargs):
64 |
65 | child_serializer = cls(*args, **kwargs)
66 | list_kwargs = {'child': child_serializer}
67 | list_kwargs.update(dict([
68 | (key, value) for key, value in kwargs.items()
69 | if key in LIST_SERIALIZER_KWARGS
70 | ]))
71 | return SerializerPermissionMixin.PermissionListSerializer(*args, **list_kwargs)
72 |
73 |
74 | # pylint: disable=missing-docstring
75 | class BooleanField(PermissionMixin, fields.BooleanField):
76 | pass
77 |
78 |
79 | try:
80 | # pylint: disable=missing-docstring
81 | class NullBooleanField(PermissionMixin, fields.NullBooleanField):
82 | pass
83 | except AttributeError:
84 | pass
85 |
86 |
87 | # pylint: disable=missing-docstring
88 | class CharField(PermissionMixin, fields.CharField):
89 | pass
90 |
91 |
92 | # pylint: disable=missing-docstring
93 | class EmailField(PermissionMixin, fields.EmailField):
94 | pass
95 |
96 |
97 | # pylint: disable=missing-docstring
98 | class RegexField(PermissionMixin, fields.RegexField):
99 | pass
100 |
101 |
102 | # pylint: disable=missing-docstring
103 | class SlugField(PermissionMixin, fields.SlugField):
104 | pass
105 |
106 |
107 | # pylint: disable=missing-docstring
108 | class URLField(PermissionMixin, fields.URLField):
109 | pass
110 |
111 |
112 | # pylint: disable=missing-docstring
113 | class IntegerField(PermissionMixin, fields.IntegerField):
114 | pass
115 |
116 |
117 | # pylint: disable=missing-docstring
118 | class FloatField(PermissionMixin, fields.FloatField):
119 | pass
120 |
121 |
122 | # pylint: disable=missing-docstring
123 | class DecimalField(PermissionMixin, fields.DecimalField):
124 | pass
125 |
126 |
127 | # pylint: disable=missing-docstring
128 | class DateField(PermissionMixin, fields.DateField):
129 | pass
130 |
131 |
132 | # pylint: disable=missing-docstring
133 | class DateTimeField(PermissionMixin, fields.DateTimeField):
134 | pass
135 |
136 |
137 | # pylint: disable=missing-docstring
138 | class TimeField(PermissionMixin, fields.TimeField):
139 | pass
140 |
141 |
142 | # pylint: disable=missing-docstring
143 | class ChoiceField(PermissionMixin, fields.ChoiceField):
144 | pass
145 |
146 |
147 | # pylint: disable=missing-docstring
148 | class MultipleChoiceField(PermissionMixin, fields.MultipleChoiceField):
149 | pass
150 |
151 |
152 | # pylint: disable=missing-docstring
153 | class FileField(PermissionMixin, fields.FileField):
154 | pass
155 |
156 |
157 | # pylint: disable=missing-docstring
158 | class ImageField(PermissionMixin, fields.ImageField):
159 | pass
160 |
161 |
162 | # pylint: disable=missing-docstring
163 | class ListField(PermissionMixin, fields.ListField):
164 | pass
165 |
166 | # pylint: disable=missing-docstring
167 | # pylint: disable=abstract-method
168 | class ReadOnlyField(PermissionMixin, fields.ReadOnlyField):
169 | pass
170 |
171 |
172 | # pylint: disable=missing-docstring
173 | # pylint: disable=abstract-method
174 | class HiddenField(PermissionMixin, fields.HiddenField):
175 | pass
176 |
177 |
178 | # pylint: disable=missing-docstring
179 | class ModelField(PermissionMixin, fields.ModelField):
180 | pass
181 |
182 |
183 | # pylint: disable=missing-docstring
184 | # pylint: disable=abstract-method
185 | class SerializerMethodField(PermissionMixin, fields.SerializerMethodField):
186 | pass
187 |
188 |
189 | # pylint: disable=missing-docstring
190 | class JSONField(PermissionMixin, fields.JSONField):
191 | pass
192 |
193 |
194 |
--------------------------------------------------------------------------------
/rest_framework_serializer_field_permissions/permissions.py:
--------------------------------------------------------------------------------
1 | """
2 | Permissions to use with the rest_framework_serializer_field_permissions.field classes:
3 |
4 | class PersonSerializer(FieldPermissionSerializerMixin, serializers.ModelSerializer):
5 |
6 | family_names = fields.CharField(permission_classes=(IsAuthenticated(), ))
7 | given_names = fields.CharField(permission_classes=(IsAuthenticated(), ))
8 | nick_name = fields.CharField(permission_classes=(AllowAny(), ))
9 | """
10 |
11 |
12 | class BaseFieldPermission(object):
13 | """
14 | The permission from which all other field-permissions inherit.
15 |
16 | Create your own field-permissions by extending this object and overriding
17 | has_permission.
18 | """
19 |
20 | # pylint: disable=no-self-use
21 | def has_permission(self, request):
22 | """
23 | Return true if permission is granted, return false if permission is
24 | denied.
25 | """
26 | return True
27 |
28 |
29 | class AllowAny(BaseFieldPermission):
30 | """
31 | Permission which allows free-access to the given field.
32 | """
33 |
34 | def has_permission(self, request):
35 | return True
36 |
37 |
38 | class AllowNone(BaseFieldPermission):
39 | """
40 | Permission which allows no access to the given field.
41 | """
42 |
43 | def has_permission(self, request):
44 | return False
45 |
46 |
47 | class IsAuthenticated(BaseFieldPermission):
48 | """
49 | Permission which only allows authenticated users access to the field.
50 | """
51 |
52 | def has_permission(self, request):
53 | return request.user and request.user.is_authenticated
54 |
--------------------------------------------------------------------------------
/rest_framework_serializer_field_permissions/serializers.py:
--------------------------------------------------------------------------------
1 | """
2 | Drop in serializer mixins.
3 | """
4 |
5 |
6 | class FieldPermissionSerializerMixin(object):
7 | """
8 | Mixin to your serializer class as follows:
9 |
10 | class PersonSerializer(FieldPermissionSerializerMixin, serializers.ModelSerializer):
11 |
12 | family_names = fields.CharField(permission_classes=(IsAuthenticated(), ))
13 | given_names = fields.CharField(permission_classes=(IsAuthenticated(), ))
14 | """
15 |
16 | @property
17 | def fields(self):
18 | """
19 | Supercedes drf's serializers.ModelSerializer's fields property
20 | :return: a set of permission-scrubbed fields
21 | """
22 | ret = super(FieldPermissionSerializerMixin, self).fields
23 | request = self.context.get('request', None)
24 |
25 | if request is None:
26 | raise RuntimeError(
27 | "Request object not available. Did you forget to add the rest_framework_serializer_field_permissions "
28 | "middleware? See https://github.com/InterSIS/django-rest-serializer-field-permissions ")
29 |
30 | forbidden_field_names = [
31 | field_name for field_name, field in ret.items() if hasattr(field, 'check_permission') and (not field.check_permission(request))
32 | ]
33 |
34 | for field_name in forbidden_field_names:
35 | ret.pop(field_name)
36 |
37 | return ret
38 |
--------------------------------------------------------------------------------
/rest_framework_serializer_field_permissions/test_app/__init__.py:
--------------------------------------------------------------------------------
1 | __author__ = 'kwong93'
2 |
--------------------------------------------------------------------------------
/rest_framework_serializer_field_permissions/test_app/models.py:
--------------------------------------------------------------------------------
1 | from django.db import models
2 |
3 |
4 | class Album(models.Model):
5 | album_name = models.TextField()
6 | artist = models.TextField()
7 |
8 |
9 | class Track(models.Model):
10 | duration = models.IntegerField()
11 | order = models.TextField()
12 | title = models.TextField()
13 | album = models.ForeignKey(to=Album, related_name='tracks', on_delete=models.CASCADE)
14 |
--------------------------------------------------------------------------------
/rest_framework_serializer_field_permissions/tests/__init__.py:
--------------------------------------------------------------------------------
1 | __author__ = 'jschilz'
2 |
--------------------------------------------------------------------------------
/rest_framework_serializer_field_permissions/tests/runtests.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 | import glob
3 | import os
4 | import sys
5 |
6 | import django
7 | from django.conf import settings
8 | from django.core.management import execute_from_command_line
9 |
10 |
11 | BASE_DIR = os.path.abspath(os.path.dirname(__file__))
12 | sys.path.append(os.path.abspath(os.path.join(BASE_DIR, '..')))
13 |
14 | # Unfortunately, apps can not be installed via ``modify_settings``
15 | # decorator, because it would miss the database setup.
16 | CUSTOM_INSTALLED_APPS = (
17 | 'rest_framework',
18 | 'test_app'
19 | )
20 |
21 | ALWAYS_INSTALLED_APPS = (
22 | 'django.contrib.auth',
23 | 'django.contrib.contenttypes',
24 | 'django.contrib.sessions',
25 | 'django.contrib.messages',
26 | 'django.contrib.staticfiles',
27 | )
28 |
29 | ALWAYS_MIDDLEWARE_CLASSES = (
30 | 'django.contrib.sessions.middleware.SessionMiddleware',
31 | 'django.middleware.common.CommonMiddleware',
32 | 'django.middleware.csrf.CsrfViewMiddleware',
33 | 'django.contrib.auth.middleware.AuthenticationMiddleware',
34 | 'django.contrib.messages.middleware.MessageMiddleware',
35 | 'django.middleware.clickjacking.XFrameOptionsMiddleware',
36 | )
37 |
38 |
39 | settings.configure(
40 | SECRET_KEY="django_tests_secret_key",
41 | DEBUG=False,
42 | TEMPLATE_DEBUG=False,
43 | ALLOWED_HOSTS=[],
44 | INSTALLED_APPS=ALWAYS_INSTALLED_APPS + CUSTOM_INSTALLED_APPS,
45 | MIDDLEWARE_CLASSES=ALWAYS_MIDDLEWARE_CLASSES,
46 | DATABASES={
47 | 'default': {
48 | 'ENGINE': 'django.db.backends.sqlite3',
49 | }
50 | },
51 | LANGUAGE_CODE='en-us',
52 | TIME_ZONE='UTC',
53 | USE_I18N=True,
54 | USE_L10N=True,
55 | USE_TZ=True,
56 | STATIC_URL='/static/',
57 | # Use a fast hasher to speed up tests.
58 | PASSWORD_HASHERS=(
59 | 'django.contrib.auth.hashers.MD5PasswordHasher',
60 | ),
61 | FIXTURE_DIRS=glob.glob(BASE_DIR + '/' + '*/fixtures/'),
62 |
63 | )
64 |
65 | try:
66 | django.setup()
67 | except AttributeError:
68 | pass
69 |
70 | args = [sys.argv[0], 'test']
71 | # Current module (``tests``) and its submodules.
72 | test_cases = '.'
73 |
74 | # Allow accessing test options from the command line.
75 | offset = 1
76 | try:
77 | sys.argv[1]
78 | except IndexError:
79 | pass
80 | else:
81 | option = sys.argv[1].startswith('-')
82 | if not option:
83 | test_cases = sys.argv[1]
84 | offset = 2
85 |
86 | args.append(test_cases)
87 | # ``verbosity`` can be overwritten from command line.
88 | args.append('--verbosity=2')
89 | args.extend(sys.argv[offset:])
90 |
91 | execute_from_command_line(args)
92 |
--------------------------------------------------------------------------------
/rest_framework_serializer_field_permissions/tests/tests.py:
--------------------------------------------------------------------------------
1 | from argparse import Namespace
2 |
3 | from django.contrib.auth.models import User, AnonymousUser
4 | from django.test import TestCase, RequestFactory
5 |
6 | from rest_framework import serializers
7 |
8 | from rest_framework_serializer_field_permissions.permissions import AllowAny, AllowNone, IsAuthenticated
9 | from rest_framework_serializer_field_permissions.fields import BooleanField, IntegerField, SerializerPermissionMixin
10 | from rest_framework_serializer_field_permissions.serializers import FieldPermissionSerializerMixin
11 | from test_app.models import Album, Track
12 |
13 |
14 | class PermissionTests(TestCase):
15 | def test_allow_any(self):
16 | permission = AllowAny()
17 |
18 | self.assertTrue(permission.has_permission({}))
19 |
20 | def test_allow_none(self):
21 | permission = AllowNone()
22 |
23 | self.assertFalse(permission.has_permission({}))
24 |
25 | def test_is_authenticated(self):
26 | permission = IsAuthenticated()
27 |
28 | authenticated_user = Namespace(is_authenticated=True)
29 | authenticated_request = Namespace(user=authenticated_user)
30 | self.assertTrue(permission.has_permission(authenticated_request))
31 |
32 | unauthenticated_user = Namespace(is_authenticated=False)
33 | unauthenticated_request = Namespace(user=unauthenticated_user)
34 | self.assertFalse(permission.has_permission(unauthenticated_request))
35 |
36 |
37 | class FieldTests(TestCase):
38 | def test_permission_field_assignment(self):
39 | field = BooleanField()
40 | self.assertTrue(hasattr(field, "permission_classes"))
41 | self.assertEqual(len(field.permission_classes), 0)
42 |
43 | field = BooleanField(permission_classes=(AllowAny(), AllowNone()))
44 | self.assertTrue(hasattr(field, "permission_classes"))
45 | self.assertEqual(len(field.permission_classes), 2)
46 |
47 | def test_single_permission_checking(self):
48 | field = BooleanField(permission_classes=(AllowAny(),))
49 | self.assertTrue(field.check_permission({}))
50 |
51 | field = BooleanField(permission_classes=(AllowNone(),))
52 | self.assertFalse(field.check_permission({}))
53 |
54 | field = BooleanField(permission_classes=(IsAuthenticated(),))
55 | authenticated_user = Namespace(is_authenticated=True)
56 | authenticated_request = Namespace(user=authenticated_user)
57 | self.assertTrue(field.check_permission(authenticated_request))
58 |
59 | unauthenticated_user = Namespace(is_authenticated=False)
60 | unauthenticated_request = Namespace(user=unauthenticated_user)
61 | self.assertFalse(field.check_permission(unauthenticated_request))
62 |
63 | def test_multiple_permission_checking(self):
64 | """
65 | Field check_permission should only return true if all of its permissions return true
66 | """
67 |
68 | field = BooleanField(permission_classes=(AllowAny(), AllowNone()))
69 | self.assertFalse(field.check_permission({}))
70 |
71 | field = BooleanField(permission_classes=(AllowNone(), AllowAny()))
72 | self.assertFalse(field.check_permission({}))
73 |
74 | field = BooleanField(permission_classes=(AllowNone(), AllowNone()))
75 | self.assertFalse(field.check_permission({}))
76 |
77 | field = BooleanField(permission_classes=(AllowAny(), AllowAny()))
78 | self.assertTrue(field.check_permission({}))
79 |
80 |
81 | class TrackSerializer(SerializerPermissionMixin, serializers.ModelSerializer):
82 | class Meta:
83 | model = Track
84 | fields = ('order', 'title')
85 |
86 |
87 | class SerializerFieldTests(TestCase):
88 | def setUp(self):
89 | self.album = Album.objects.create(album_name='Album Name',
90 | artist='Album Artist')
91 |
92 | Track.objects.create(album=self.album,
93 | order=1,
94 | title='Public Service Announcement',
95 | duration=245)
96 |
97 | def get_album_serializer(self, _tracks):
98 | class AlbumSerializer(FieldPermissionSerializerMixin, serializers.ModelSerializer):
99 | tracks = _tracks
100 |
101 | class Meta:
102 | model = Album
103 | fields = ('album_name', 'artist', 'tracks')
104 |
105 | return AlbumSerializer
106 |
107 | def test_many_false_serializer_field(self):
108 | field = TrackSerializer(permission_classes=(AllowNone(),))
109 | self.assertFalse(field.check_permission({}))
110 |
111 | def test_many_true_serializer_field(self):
112 | field = TrackSerializer(permission_classes=(AllowNone(),), many=True)
113 |
114 | self.assertFalse(field.check_permission({}))
115 |
116 | def test_many_false_serializer_field_removed(self):
117 | tracks = TrackSerializer(permission_classes=(AllowNone(),))
118 |
119 | album_serializer = self.get_album_serializer(tracks)(instance=self.album, context={'request': {}})
120 |
121 | self.assertFalse('tracks' in album_serializer.data)
122 |
123 | def test_many_true_serializer_field_removed(self):
124 | tracks = TrackSerializer(permission_classes=(AllowNone(),), many=True)
125 |
126 | album_serializer = self.get_album_serializer(tracks)(instance=self.album, context={'request': {}})
127 |
128 | self.assertFalse('tracks' in album_serializer.data)
129 |
130 |
131 | class TrackPermissionSerializer(SerializerPermissionMixin, FieldPermissionSerializerMixin, serializers.ModelSerializer):
132 | duration = IntegerField(permission_classes=(IsAuthenticated(), ))
133 |
134 | class Meta:
135 | model = Track
136 | fields = ('order', 'title', 'duration')
137 |
138 |
139 | class AlbumNestedSerializer(FieldPermissionSerializerMixin, serializers.ModelSerializer):
140 | tracks = TrackPermissionSerializer(many=True)
141 |
142 | class Meta:
143 | model = Album
144 | fields = ('album_name', 'artist', 'tracks')
145 |
146 |
147 | class NestedSerializerTests(TestCase):
148 | def setUp(self):
149 | self.user = User.objects.create_user(username='Album Artist', email='jacob@jacob.com', password='top_secret')
150 | self.album = Album.objects.create(album_name='Album Name',
151 | artist='Album Artist')
152 |
153 | Track.objects.create(album=self.album,
154 | order=1,
155 | title='Public Service Announcement',
156 | duration=245)
157 |
158 | self.request = RequestFactory().get(f'/album/{self.album.album_name}')
159 | self.request.user = self.user
160 |
161 | def test_request_context_passed_to_nested_serializer(self):
162 | album_serializer = AlbumNestedSerializer(instance=self.album, context={'request': self.request})
163 | self.assertTrue(album_serializer.fields['tracks'].context['request'] == self.request)
164 | self.assertTrue('duration' in album_serializer.data['tracks'][0])
165 |
166 | self.request.user = AnonymousUser()
167 | album_serializer = AlbumNestedSerializer(instance=self.album, context={'request': self.request})
168 | self.assertFalse('duration' in album_serializer.data['tracks'][0])
169 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | import os
2 | from setuptools import setup
3 |
4 | with open(os.path.join(os.path.dirname(__file__), 'README.md')) as readme:
5 | README = readme.read()
6 |
7 | # allow setup.py to be run from any path
8 | os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
9 |
10 | setup(
11 | name='django-rest-serializer-field-permissions',
12 | version='4.1.0',
13 | packages=['rest_framework_serializer_field_permissions'],
14 | include_package_data=True,
15 | license='GNU General Public License v3 (GPLv3)',
16 | description='Field-by-field serializer permissions for Django Rest Framework.',
17 | long_description=README,
18 | long_description_content_type='text/markdown',
19 | url='https://github.com/InterSIS/django-rest-serializer-field-permissions/',
20 | author='The Intersis Foundation',
21 | author_email='dev@intersis.org',
22 | install_requires=[
23 | 'django>=3.0',
24 | 'djangorestframework~=3.0',
25 | ],
26 | extras_require={
27 | 'dev': [
28 | 'tox',
29 | 'twine',
30 | ]
31 | },
32 | classifiers=[
33 | 'Environment :: Web Environment',
34 | 'Framework :: Django',
35 | 'Intended Audience :: Developers',
36 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
37 | 'Operating System :: OS Independent',
38 | 'Programming Language :: Python',
39 | 'Programming Language :: Python :: 3.7',
40 | 'Topic :: Internet :: WWW/HTTP',
41 | 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
42 | ],
43 | )
44 |
--------------------------------------------------------------------------------
/tox.ini:
--------------------------------------------------------------------------------
1 | [tox]
2 | envlist =
3 | {py38}-django{3.2,4.2}-drf{3.14},
4 | lint,
5 | coveralls
6 |
7 | toxworkdir = {env:TOX_WORK_DIR:.tox}
8 |
9 | [testenv:lint]
10 | deps = pylint
11 |
12 | commands = pylint rest_framework_serializer_field_permissions --rcfile=.pylintrc --disable=fixme --disable=locally-disabled --disable=too-few-public-methods --disable=unused-argument
13 |
14 | [testenv:coveralls]
15 | passenv = TRAVIS TRAVIS_JOB_ID TRAVIS_BRANCH
16 |
17 | deps =
18 | coveralls
19 | Django==4.2
20 | djangorestframework==3.14.0
21 | pycrypto==2.6.1
22 |
23 | commands =
24 | coverage run --source=rest_framework_serializer_field_permissions --omit=tests/* --omit=test_app/* rest_framework_serializer_field_permissions/tests/runtests.py
25 | coveralls
26 |
27 | [testenv]
28 | commands = python rest_framework_serializer_field_permissions/tests/runtests.py
29 |
30 | deps =
31 | django3.2: Django==3.2.18
32 | django4.2: Django==4.2
33 | drf3.14: djangorestframework==3.14.0
34 |
--------------------------------------------------------------------------------