poojaruhal/Code-comment-classification

1stratum,class,comment,Summary,Usage,Parameters,Expand,Version,DevelopmentNotes,Todo,Exception,Links,Noise,Warnings,Recommendation,Dependecies,Precondition,CodingGuidelines,Extension,Subclassexplnation,Observation21,AccessMixin,"Abstract CBV mixin that gives access mixins the same customizable3functionality.","Abstract CBV mixin that gives access mixins the same customizable4functionality.",,,,,,,,,,,,,,,,,51,AmbiguityError,More than one migration matches a name prefix.,More than one migration matches a name prefix.,,,,,,,,,,,,,,,,,61,AppConfigStub,Stub of an AppConfig. Only provides a label and a dict of models.,Stub of an AppConfig.,,Only provides a label and a dict of models.,,,,,,,,,,,,,,,71,Archive,The external API class that encapsulates an archive implementation.,The external API class that encapsulates an archive implementation.,,,,,The external API class that encapsulates an archive implementation.,,,,,,,,,,,,81,ArchiveIndexView,Top-level archive of date-based items.,Top-level archive of date-based items.,,,,,,,,,,,,,,,,,91,Atomic,"Guarantee the atomic execution of a given block.10 11An instance can be used either as a decorator or as a context manager.12 13When it's used as a decorator, __call__ wraps the execution of the14decorated function in the instance itself, used as a context manager.15 16When it's used as a context manager, __enter__ creates a transaction or a17savepoint, depending on whether a transaction is already in progress, and18__exit__ commits the transaction or releases the savepoint on normal exit,19and rolls back the transaction or to the savepoint on exceptions.20 21It's possible to disable the creation of savepoints if the goal is to22ensure that some code runs within a transaction without creating overhead.23 24A stack of savepoints identifiers is maintained as an attribute of the25connection. None denotes the absence of a savepoint.26 27This allows reentrancy even if the same AtomicWrapper is reused. For28example, it's possible to define `oa = atomic('other')` and use `@oa` or29`with oa:` multiple times.30 31Since database connections are thread-local, this is thread-safe.32 33This is a private API.",Guarantee the atomic execution of a given block.,"When it's used as a decorator, __call__ wraps the execution of the34decorated function in the instance itself, used as a context manager.35 36When it's used as a context manager, __enter__ creates a transaction or a37savepoint, depending on whether a transaction is already in progress, and38__exit__ commits the transaction or releases the savepoint on normal exit,39and rolls back the transaction or to the savepoint on exceptions.40 41It's possible to disable the creation of savepoints if the goal is to42ensure that some code runs within a transaction without creating overhead.43 44A stack of savepoints identifiers is maintained as an attribute of the45connection. None denotes the absence of a savepoint.46 47This allows reentrancy even if the same AtomicWrapper is reused.",,"An instance can be used either as a decorator or as a context manager.When it's used as a decorator, __call__ wraps the execution of the48decorated function in the instance itself, used as a context manager.",,,,,,,"This is a private API.49Since database connections are thread-local, this is thread-safe.",,,,,,,501,AtomicTests,"Tests for the atomic decorator and context manager.51 52The tests make assertions on internal attributes because there isn't a53robust way to ask the database for its current transaction state.54 55Since the decorator syntax is converted into a context manager (see the56implementation), there are only a few basic tests with the decorator57syntax and the bulk of the tests use the context manager syntax.",Tests for the atomic decorator and context manager.,,,"The tests make assertions on internal attributes because there isn't a58robust way to ask the database for its current transaction state.59 60Since the decorator syntax is converted into a context manager (see the61implementation), there are only a few basic tests with the decorator62syntax and the bulk of the tests use the context manager syntax.",,,,,,,,,,,,,,631,AutoFieldMeta,"Metaclass to maintain backward inheritance compatibility for AutoField.64 65It is intended that AutoFieldMixin become public API when it is possible to66create a non-integer automatically-generated field using column defaults67stored in the database.68 69In many areas Django also relies on using isinstance() to check for an70automatically-generated field as a subclass of AutoField. A new flag needs71to be implemented on Field to be used instead.72 73When these issues have been addressed, this metaclass could be used to74deprecate inheritance from AutoField and use of isinstance() with AutoField75for detecting automatically-generated fields.",Metaclass to maintain backward inheritance compatibility for AutoField.,"In many areas Django also relies on using isinstance() to check for an76automatically-generated field as a subclass of AutoField. A new flag needs77to be implemented on Field to be used instead.",,"It is intended that AutoFieldMixin become public API when it is possible to78create a non-integer automatically-generated field using column defaults79stored in the database.",,"When these issues have been addressed, this metaclass could be used to80deprecate inheritance from AutoField and use of isinstance() with AutoField81for detecting automatically-generated fields.",,,,,,"A new flag needs82to be implemented on Field to be used instead.83When these issues have been addressed, this metaclass could be used to84deprecate inheritance from AutoField and use of isinstance() with AutoField85for detecting automatically-generated fields.","In many areas Django also relies on using isinstance() to check for an86automatically-generated field as a subclass of AutoField",,,,,871,BadSignature,Signature does not match.,Signature does not match.,,,,,,,,,,,,,,,,,881,BarAccount,A service-specific account of type Bar.,A service-specific account of type Bar.,,,,,,,,,,,,,,,,,891,BaseCommand,"The base class from which all management commands ultimately90derive.91 92Use this class if you want access to all of the mechanisms which93parse the command-line arguments and work out what code to call in94response; if you don't need to change any of that behavior,95consider using one of the subclasses defined in this file.96 97If you are interested in overriding/customizing various aspects of98the command-parsing and -execution behavior, the normal flow works99as follows:100 1011. ``django-admin`` or ``manage.py`` loads the command class102   and calls its ``run_from_argv()`` method.103 1042. The ``run_from_argv()`` method calls ``create_parser()`` to get105   an ``ArgumentParser`` for the arguments, parses them, performs106   any environment changes requested by options like107   ``pythonpath``, and then calls the ``execute()`` method,108   passing the parsed arguments.109 1103. The ``execute()`` method attempts to carry out the command by111   calling the ``handle()`` method with the parsed arguments; any112   output produced by ``handle()`` will be printed to standard113   output and, if the command is intended to produce a block of114   SQL statements, will be wrapped in ``BEGIN`` and ``COMMIT``.115 1164. If ``handle()`` or ``execute()`` raised any exception (e.g.117   ``CommandError``), ``run_from_argv()`` will  instead print an error118   message to ``stderr``.119 120Thus, the ``handle()`` method is typically the starting point for121subclasses; many built-in commands and command types either place122all of their logic in ``handle()``, or perform some additional123parsing work in ``handle()`` and then delegate from it to more124specialized methods as needed.125 126Several attributes affect behavior at various steps along the way:127 128``help``129    A short description of the command, which will be printed in130    help messages.131 132``output_transaction``133    A boolean indicating whether the command outputs SQL134    statements; if ``True``, the output will automatically be135    wrapped with ``BEGIN;`` and ``COMMIT;``. Default value is136    ``False``.137 138``requires_migrations_checks``139    A boolean; if ``True``, the command prints a warning if the set of140    migrations on disk don't match the migrations in the database.141 142``requires_system_checks``143    A boolean; if ``True``, entire Django project will be checked for errors144    prior to executing the command. Default value is ``True``.145    To validate an individual application's models146    rather than all applications' models, call147    ``self.check(app_configs)`` from ``handle()``, where ``app_configs``148    is the list of application's configuration provided by the149    app registry.150 151``stealth_options``152    A tuple of any options the command uses which aren't defined by the153    argument parser.","The base class from which all management commands ultimately154derive.","If you are interested in overriding/customizing various aspects of155the command-parsing and -execution behavior, the normal flow works156as follows:157 1581. ``django-admin`` or ``manage.py`` loads the command class159   and calls its ``run_from_argv()`` method.160 1612. The ``run_from_argv()`` method calls ``create_parser()`` to get162   an ``ArgumentParser`` for the arguments, parses them, performs163   any environment changes requested by options like164   ``pythonpath``, and then calls the ``execute()`` method,165   passing the parsed arguments.166 1673. The ``execute()`` method attempts to carry out the command by168   calling the ``handle()`` method with the parsed arguments; any169   output produced by ``handle()`` will be printed to standard170   output and, if the command is intended to produce a block of171   SQL statements, will be wrapped in ``BEGIN`` and ``COMMIT``.172 1734. If ``handle()`` or ``execute()`` raised any exception (e.g.174   ``CommandError``), ``run_from_argv()`` will  instead print an error175   message to ``stderr``.","Several attributes affect behavior at various steps along the way:176 177``help``178    A short description of the command, which will be printed in179    help messages.180 181``output_transaction``182    A boolean indicating whether the command outputs SQL183    statements; if ``True``, the output will automatically be184    wrapped with ``BEGIN;`` and ``COMMIT;``. Default value is185    ``False``.186 187``requires_migrations_checks``188    A boolean; if ``True``, the command prints a warning if the set of189    migrations on disk don't match the migrations in the database.190 191``requires_system_checks``192    A boolean; if ``True``, entire Django project will be checked for errors193    prior to executing the command. Default value is ``True``.194    To validate an individual application's models195    rather than all applications' models, call196    ``self.check(app_configs)`` from ``handle()``, where ``app_configs``197    is the list of application's configuration provided by the198    app registry.",,,"Use this class if you want access to all of the mechanisms which199parse the command-line arguments and work out what code to call in200response; if you don't need to change any of that behavior,201consider using one of the subclasses defined in this file.202 203Thus, the ``handle()`` method is typically the starting point for204subclasses; many built-in commands and command types either place205all of their logic in ``handle()``, or perform some additional206parsing work in ``handle()`` and then delegate from it to more207specialized methods as needed.",,,,,,"Use this class if you want access to all of the mechanisms which parse the command-line arguments and work out what code to call in response; if you don't need to change any of that behavior, consider using one of the subclasses defined in this file.",,,,,"Use this class if you want access to all of the mechanisms which208parse the command-line arguments and work out what code to call in209response; if you don't need to change any of that behavior,210consider using one of the subclasses defined in this file.",2111,BaseDatabaseSchemaEditor,"This class and its subclasses are responsible for emitting schema-changing212statements to the databases - model creation/removal/alteration, field213renaming, index fiddling, and so on.","This class and its subclasses are responsible for emitting schema-changing214statements to the databases - model creation/removal/alteration, field215renaming, index fiddling, and so on.",,,,,"This class and its subclasses are responsible for emitting schema-changing216statements to the databases - model creation/removal/alteration, field217renaming, index fiddling, and so on.",,,,,,,,,,,,2181,BaseExpression,Base class for all query expressions.,Base class for all query expressions.,,,,,,,,,,,,,,,,,2191,BaseUpdateView,"Base view for updating an existing object.220 221Using this base class requires subclassing to provide a response mixin.",Base view for updating an existing object.,,,,,Using this base class requires subclassing to provide a response mixin.,,,,,,,,,,,,2221,BaseYearArchiveView,List of objects published in a given year.,List of objects published in a given year.,,,,,,,,,,,,,,,,,2231,BCryptSHA256PasswordHasher,"Secure password hashing using the bcrypt algorithm (recommended)224 225This is considered by many to be the most secure algorithm but you226must first install the bcrypt library.  Please be warned that227this library depends on native C code and might cause portability228issues.",Secure password hashing using the bcrypt algorithm (recommended),"This is considered by many to be the most secure algorithm but you229must first install the bcrypt library.",,,,,,,,,"Please be warned that230this library depends on native C code and might cause portability231issues.",,,,,,,2321,BoundWidget,"A container class used for iterating over widgets. This is useful for233widgets that have choices. For example, the following can be used in a234template:235 236{% for radio in myform.beatles %}237  <label for=""{{ radio.id_for_label }}"">238    {{ radio.choice_label }}239    <span class=""radio"">{{ radio.tag }}</span>240  </label>241{% endfor %}",A container class used for iterating over widgets.,"For example, the following can be used in a242template:243 244{% for radio in myform.beatles %}245  <label for=""{{ radio.id_for_label }}"">246    {{ radio.choice_label }}247    <span class=""radio"">{{ radio.tag }}</span>248  </label>249{% endfor %}",,,,"This is useful for250widgets that have choices.",,,,,,,,,,,,2511,CacheHandler,"A Cache Handler to manage access to Cache instances.252 253Ensure only one instance of each alias exists per thread.",A Cache Handler to manage access to Cache instances.,,,Ensure only one instance of each alias exists per thread.,,,,,,,,,,,,,,2541,Choices,Class for creating enumerated choices.,Class for creating enumerated choices.,,Class for creating enumerated choices.,,,,,,,,,,,,,,,2551,ChunkIter,"An iterable that will yield chunks of data. Given a file-like object as the256constructor, yield chunks of read operations from that object.",An iterable that will yield chunks of data.,,,"Given a file-like object as the257constructor, yield chunks of read operations from that object.",,,,,,,,,,,,,,2581,Client,"A class that can act as a client for testing purposes.259 260It allows the user to compose GET and POST requests, and261obtain the response that the server gave to those requests.262The server Response objects are annotated with the details263of the contexts and templates that were rendered during the264process of serving the request.265 266Client objects are stateful - they will retain cookie (and267thus session) details for the lifetime of the Client instance.268 269This is not intended as a replacement for Twill/Selenium or270the like - it is here to allow testing against the271contexts and templates produced by a view, rather than the272HTML rendered to the end-user.",A class that can act as a client for testing purposes.,,,"It allows the user to compose GET and POST requests, and273obtain the response that the server gave to those requests.274The server Response objects are annotated with the details275of the contexts and templates that were rendered during the276process of serving the request.277 278Client objects are stateful - they will retain cookie (and279thus session) details for the lifetime of the Client instance.",,"This is not intended as a replacement for Twill/Selenium or280the like - it is here to allow testing against the281contexts and templates produced by a view, rather than the282HTML rendered to the end-user.",,,,,"This is not intended as a replacement for Twill/Selenium or283the like - it is here to allow testing against the284contexts and templates produced by a view, rather than the285HTML rendered to the end-user.",,,,,,,2861,Combinable,"Provide the ability to combine one or two objects with287some connector. For example F('foo') + F('bar').","Provide the ability to combine one or two objects with288some connector.",For example F('foo') + F('bar').,,,,,,,,,,,,,,,,2891,ConsoleDirective,"A reStructuredText directive which renders a two-tab code block in which290the second tab shows a Windows command line equivalent of the usual291Unix-oriented examples.","A reStructuredText directive which renders a two-tab code block in which292the second tab shows a Windows command line equivalent of the usual293Unix-oriented examples.",,,,,,,,,,,,,,,,,2941,Context,A stack container for variable context,A stack container for variable context,,,,,,,,,,,,,,,,,2951,CryptPasswordHasher,"Password hashing using UNIX crypt (not recommended)296 297The crypt module is not supported on all platforms.",Password hashing using UNIX crypt (not recommended),,,,,The crypt module is not supported on all platforms.,,,,,,Password hashing using UNIX crypt (not recommended),,,,,,2981,CustomArticleAdmin,Tests various hooks for using custom templates and contexts.,Tests various hooks for using custom templates and contexts.,,,,,,,,,,,,,,,,,2991,CustomCacheKeyValidationTests,"Tests for the ability to mixin a custom ``validate_key`` method to300a custom cache backend that otherwise inherits from a builtin301backend, and override the default key validation. Refs #6447.","Tests for the ability to mixin a custom ``validate_key`` method to302a custom cache backend",,,"that otherwise inherits from a builtin303backend, and override the default key validation.",,,,,Refs #6447.,,,,,,,,,3041,CustomHeaderRemoteUserTest,"Tests a custom RemoteUserMiddleware subclass with custom HTTP auth user305header.",Tests a custom RemoteUserMiddleware subclass,,Tests a custom RemoteUserMiddleware subclass with custom HTTP auth user,,,,,,,,,,,,,,Tests a custom RemoteUserMiddleware subclass with custom HTTP auth user,3061,DatabaseReceiver,Used in the tests for the database argument in signals (#13552),Used in the tests for the database argument in signals (#13552),,,,,,,,,,,,,,,,,3071,DblFromGeom,"Argument is a Geometry, return type is double that is passed308in by reference as the last argument.",,,"Argument is a Geometry,309 310return type is double that is passed311in by reference as the last argument",,,,,,,,,,,,,,,3121,DisallowedModelAdminToField,Invalid to_field was passed to admin view via URL query string,Invalid to_field was passed to admin view via URL query string,,,,,,,,,,,,,,,,,3131,DjangoHTMLTranslator,Django-specific reST to HTML tweaks.,Django-specific reST to HTML tweaks.,,,,,,,,,,,,,,,,,3141,Dumpdata,Tests for dumpdata management command.,Tests for dumpdata management command.,,,,,,,,,,,,,,,,,3151,EarliestOrLatestTests,Tests for the earliest() and latest() objects methods,Tests for the earliest() and latest() objects methods,,,,,,,,,,,,,,,,,3161,EmptyStringsAsNullTest,"Filtering on non-null character fields works as expected.317The reason for these tests is that Oracle treats '' as NULL, and this318can cause problems in query construction. Refs #17957.",,,,,,,,,Refs #17957.,,,,,,,,,3191,ErrorDict,"A collection of errors that knows how to display itself in various formats.320 321The dictionary keys are the field names, and the values are the errors.",A collection of errors that knows how to display itself in various formats.,"The dictionary keys are the field names, and the values are the errors.",,,,,,,,,,,,,,,,3221,ExceptionThatFailsUnpickling,"After pickling, this class fails unpickling with an error about incorrect323arguments passed to __init__().","After pickling, this class fails unpickling with an error about incorrect324arguments passed to __init__().",,,,,,,,,,,,,,,,,3251,FakePayload,"A wrapper around BytesIO that restricts what can be read since data from326the network can't be sought and cannot be read outside of its content327length. This makes sure that views can't do anything under the test client328that wouldn't work in real life.","A wrapper around BytesIO that restricts what can be read since data from329the network can't be sought and cannot be read outside of its content330length.",,,"This makes sure that views can't do anything under the test client331that wouldn't work in real life.",,,,,,,,,,,,,,3321,FallbackStorage,"Try to store all messages in the first backend. Store any unstored333messages in each subsequent backend.",,,,"Try to store all messages in the first backend. Store any unstored334messages in each subsequent backend.",,,,,,,,,,,,,,3351,FootNote,Model added for ticket 19838,,,,,,Model added for ticket 19838,,,,,,,,,,,,3361,FrenchTestCase,Tests using the French translations of the sampleproject.,Tests using the French translations of the sampleproject.,,,,,,,,,,,,,,,,,3371,GeoFlexibleFieldLookupDict,"Subclass that includes updates the `base_data_types_reverse` dict338for geometry field types.",,,,,,,,,,,,,,,,,"Subclass that includes updates the `base_data_types_reverse` dict339for geometry field types.",3401,Group,Table Column Fields,Table Column Fields,,,,,,,,,,,,,,,,,3411,GZipMiddleware,"Compress content if the browser allows gzip compression.342Set the Vary header accordingly, so that caches will base their storage343on the Accept-Encoding header.","Compress content if the browser allows gzip compression.Set the Vary header accordingly, so that caches will base their storage344on the Accept-Encoding header.",,,,,,,,,,,,,,,,,3451,HiddenRangeWidget,"A widget that splits input into two <input type=""hidden""> inputs.","A widget that splits input into two <input type=""hidden""> inputs.",,,,,,,,,,,,,,,,,3461,ImageFileDescriptor,"Just like the FileDescriptor, but for ImageFields. The only difference is347assigning the width/height to the width_field/height_field, if appropriate.","Just like the FileDescriptor, but for ImageFields.",,,"The only difference is348assigning the width/height to the width_field/height_field, if appropriate.",,,,,,,,,,,,,,3491,IncompleteCategoryFormWithExclude,"A form that replaces the model's url field with a custom one. This should350prevent the model field's validation from being called.",A form that replaces the model's url field with a custom one.,,,,,,,,,,"This should351prevent the model field's validation from being called.",,,,,,,3521,Individual,"A model with a FK to itself. It won't be registered with the admin, so the353corresponding raw ID widget won't have a magnifying glass link to select354related instances (rendering will be called programmatically in this case).",A model with a FK to itself.,"It won't be registered with the admin, so the355corresponding raw ID widget won't have a magnifying glass link to select356related instances (rendering will be called programmatically in this case).",,,,"It won't be registered with the admin, so the357corresponding raw ID widget won't have a magnifying glass link to select358related instances (rendering will be called programmatically in this case).",,,,,,,,,,,,3591,InputStreamExhausted,No more reads are allowed from this device.,No more reads are allowed from this device.,,,No more reads are allowed from this device.,,,,,,,,,,,,,,3601,IntFromGeom,"Argument is a geometry, return type is an integer.",,,"Argument is a geometry, return type is an integer.",,,"Argument is a geometry, return type is an integer.",,,,,,,,,,,,3611,InvalidBasesError,A model's base classes can't be resolved.,A model's base classes can't be resolved.,,,,,,,,,,,,,,,,,3621,KMLSitemap,A minimal hook to produce KML sitemaps.,A minimal hook to produce KML sitemaps.,,,,,,,,,,,,,,,,,3631,ListMixin,"A base class which provides complete list interface.364Derived classes must call ListMixin's __init__() function365and implement the following:366 367function _get_single_external(self, i):368    Return single item with index i for general use.369    The index i will always satisfy 0 <= i < len(self).370 371function _get_single_internal(self, i):372    Same as above, but for use within the class [Optional]373    Note that if _get_single_internal and _get_single_internal return374    different types of objects, _set_list must distinguish375    between the two and handle each appropriately.376 377function _set_list(self, length, items):378    Recreate the entire object.379 380    NOTE: items may be a generator which calls _get_single_internal.381    Therefore, it is necessary to cache the values in a temporary:382        temp = list(items)383    before clobbering the original storage.384 385function _set_single(self, i, value):386    Set the single item at index i to value [Optional]387    If left undefined, all mutations will result in rebuilding388    the object using _set_list.389 390function __len__(self):391    Return the length392 393int _minlength:394    The minimum legal length [Optional]395 396int _maxlength:397    The maximum legal length [Optional]398 399type or tuple _allowed:400    A type or tuple of allowed item types [Optional]",A base class which provides complete list interface.,,,"Derived classes must call ListMixin's __init__() function401and implement the following:402 403function _get_single_external(self, i):404    Return single item with index i for general use.405    The index i will always satisfy 0 <= i < len(self).406 407function _get_single_internal(self, i):408    Same as above, but for use within the class [Optional]409    Note that if _get_single_internal and _get_single_internal return410    different types of objects, _set_list must distinguish411    between the two and handle each appropriately.412 413function _set_list(self, length, items):414    Recreate the entire object.415 416    NOTE: items may be a generator which calls _get_single_internal.417    Therefore, it is necessary to cache the values in a temporary:418        temp = list(items)419    before clobbering the original storage.420 421function _set_single(self, i, value):422    Set the single item at index i to value [Optional]423    If left undefined, all mutations will result in rebuilding424    the object using _set_list.425 426function __len__(self):427    Return the length428 429int _minlength:430    The minimum legal length [Optional]431 432int _maxlength:433    The maximum legal length [Optional]434 435type or tuple _allowed:436    A type or tuple of allowed item types [Optional]",,,,,,,,,,,,,,4371,LogoutThenLoginTests,Tests for the logout_then_login view,Tests for the logout_then_login view,,,,,,,,,,,,,,,,,4381,MakeListTests,"The make_list filter can destroy existing escaping, so the results are439escaped.",,,,"The make_list filter can destroy existing escaping, so the results are440escaped.",,,,,,,,,,,,,,4411,ManagementForm,"Keep track of how many form instances are displayed on the page. If adding442new forms via JavaScript, you should increment the count field of this form443as well.",Keep track of how many form instances are displayed on the page.,,,,,,,,,,,"If adding444new forms via JavaScript, you should increment the count field of this form445as well.",,,,,,4461,MemcachedCache,An implementation of a cache binding using python-memcached,An implementation of a cache binding using python-memcached,,,,,,,,,,,,,,,,,4471,MemoryFileUploadHandler,File upload handler to stream uploads into memory (used for small files).,File upload handler to stream uploads into memory (used for small files).,,,,,,,,,,,,,,,,,(used for small files)4481,Migration,"The base class for all migrations.449 450Migration files will import this from django.db.migrations.Migration451and subclass it as a class called Migration. It will have one or more452of the following attributes:453 454 - operations: A list of Operation instances, probably from django.db.migrations.operations455 - dependencies: A list of tuples of (app_path, migration_name)456 - run_before: A list of tuples of (app_path, migration_name)457 - replaces: A list of migration_names458 459Note that all migrations come out of migrations and into the Loader or460Graph as instances, having been initialized with their app label and name.",The base class for all migrations.,"It will have one or more461of the following attributes:462 463 - operations: A list of Operation instances, probably from django.db.migrations.operations464 - dependencies: A list of tuples of (app_path, migration_name)465 - run_before: A list of tuples of (app_path, migration_name)466 - replaces: A list of migration_names","It will have one or more467of the following attributes:468 469 - operations: A list of Operation instances, probably from django.db.migrations.operations470 - dependencies: A list of tuples of (app_path, migration_name)471 - run_before: A list of tuples of (app_path, migration_name)472 - replaces: A list of migration_names",,,,,,,,"Note that all migrations come out of migrations and into the Loader or473Graph as instances, having been initialized with their app label and name.",,,"Note that all migrations come out of migrations and into the Loader or474Graph as instances, having been initialized with their app label and name.",,,"Migration files will import this from django.db.migrations.Migration475and subclass it as a class called Migration.",4761,MigrationGraph,"Represent the digraph of all migrations in a project.477 478Each migration is a node, and each dependency is an edge. There are479no implicit dependencies between numbered migrations - the numbering is480merely a convention to aid file listing. Every new numbered migration481has a declared dependency to the previous number, meaning that VCS482branch merges can be detected and resolved.483 484Migrations files can be marked as replacing another set of migrations -485this is to support the ""squash"" feature. The graph handler isn't responsible486for these; instead, the code to load them in here should examine the487migration files and if the replaced migrations are all either unapplied488or not present, it should ignore the replaced ones, load in just the489replacing migration, and repoint any dependencies that pointed to the490replaced migrations to point to the replacing one.491 492A node should be a tuple: (app_path, migration_name). The tree special-cases493things within an app - namely, root nodes and leaf nodes ignore dependencies494to other apps.",Represent the digraph of all migrations in a project.,"Migrations files can be marked as replacing another set of migrations -495this is to support the ""squash"" feature.496 497 498The graph handler isn't responsible499for these; instead, the code to load them in here should examine the500migration files and if the replaced migrations are all either unapplied501or not present, it should ignore the replaced ones, load in just the502replacing migration, and repoint any dependencies that pointed to the503replaced migrations to point to the replacing one.","A node should be a tuple: (app_path, migration_name).",,,"Each migration is a node, and each dependency is an edge.504 505 506There are507no implicit dependencies between numbered migrations - the numbering is508merely a convention to aid file listing.",,,,,"The tree special-cases509things within an app - namely, root nodes and leaf nodes ignore dependencies510to other apps.","The graph handler isn't responsible511for these; instead, the code to load them in here should examine the512migration files and if the replaced migrations are all either unapplied513or not present, it should ignore the replaced ones, load in just the514replacing migration, and repoint any dependencies that pointed to the515replaced migrations to point to the replacing one.",,,,,,"Every new numbered migration516has a declared dependency to the previous number, meaning that VCS517branch merges can be detected and resolved."5181,MigrationLoader,"Load migration files from disk and their status from the database.519 520Migration files are expected to live in the ""migrations"" directory of521an app. Their names are entirely unimportant from a code perspective,522but will probably follow the 1234_name.py convention.523 524On initialization, this class will scan those directories, and open and525read the Python files, looking for a class called Migration, which should526inherit from django.db.migrations.Migration. See527django.db.migrations.migration for what that looks like.528 529Some migrations will be marked as ""replacing"" another set of migrations.530These are loaded into a separate set of migrations away from the main ones.531If all the migrations they replace are either unapplied or missing from532disk, then they are injected into the main set, replacing the named migrations.533Any dependency pointers to the replaced migrations are re-pointed to the534new migration.535 536This does mean that this class MUST also talk to the database as well as537to disk, but this is probably fine. We're already not just operating538in memory.",Load migration files from disk and their status from the database.,"This does mean that this class MUST also talk to the database as well as539to disk, but this is probably fine. We're already not just operating540in memory.",,"On initialization, this class will scan those directories, and open and541read the Python files, looking for a class called Migration, which should542inherit from django.db.migrations.Migration. See543django.db.migrations.migration for what that looks like.544 545Some migrations will be marked as ""replacing"" another set of migrations.546These are loaded into a separate set of migrations away from the main ones.547If all the migrations they replace are either unapplied or missing from548disk, then they are injected into the main set, replacing the named migrations.549Any dependency pointers to the replaced migrations are re-pointed to the550new migration.",,,,,,,,"Migration files are expected to live in the ""migrations"" directory of551an app. Their names are entirely unimportant from a code perspective,552but will probably follow the 1234_name.py convention.",,,,,,5531,MigrationQuestioner,"Give the autodetector responses to questions it might have.554This base class has a built-in noninteractive mode, but the555interactive subclass is what the command-line arguments will use.",Give the autodetector responses to questions it might have.,"This base class has a built-in noninteractive mode, but the556interactive subclass is what the command-line arguments will use.",,,,"This base class has a built-in noninteractive mode, but the557interactive subclass is what the command-line arguments will use.",,,,,,,,,,,,5581,MigrationWriter,"Take a Migration instance and is able to produce the contents559of the migration file from it.","Take a Migration instance and is able to produce the contents560of the migration file from it.",,,,,,,,,,,,,,,,,5611,ModelBase,Metaclass for all models.,Metaclass for all models.,,,,,,,,,,,,,,,,,5621,ModelSignal,"Signal subclass that allows the sender to be lazily specified as a string563of the `app_label.ModelName` form.","Signal subclass that allows the sender to be lazily specified as a string564of the `app_label.ModelName` form.",,,,,,,,,,,,,,,,"Signal subclass that allows the sender to be lazily specified as a string565of the `app_label.ModelName` form.",5661,MultiPartParser,"A rfc2388 multipart/form-data parser.567 568``MultiValueDict.parse()`` reads the input stream in ``chunk_size`` chunks569and returns a tuple of ``(MultiValueDict(POST), MultiValueDict(FILES))``.",A rfc2388 multipart/form-data parser.,,,,,"``MultiValueDict.parse()`` reads the input stream in ``chunk_size`` chunks570and returns a tuple of ``(MultiValueDict(POST), MultiValueDict(FILES))``.",,,,,,,,,,,,5711,MultiValueDict,"A subclass of dictionary customized to handle multiple values for the572same key.573 574>>> d = MultiValueDict({'name': ['Adrian', 'Simon'], 'position': ['Developer']})575>>> d['name']576'Simon'577>>> d.getlist('name')578['Adrian', 'Simon']579>>> d.getlist('doesnotexist')580[]581>>> d.getlist('doesnotexist', ['Adrian', 'Simon'])582['Adrian', 'Simon']583>>> d.get('lastname', 'nonexistent')584'nonexistent'585>>> d.setlist('lastname', ['Holovaty', 'Willison'])586 587This class exists to solve the irritating problem raised by cgi.parse_qs,588which returns a list for every key, even though most Web forms submit589single name-value pairs.","A subclass of dictionary customized to handle multiple values for the590same key.",">>> d = MultiValueDict({'name': ['Adrian', 'Simon'], 'position': ['Developer']})591>>> d['name']592'Simon'593>>> d.getlist('name')594['Adrian', 'Simon']595>>> d.getlist('doesnotexist')596[]597>>> d.getlist('doesnotexist', ['Adrian', 'Simon'])598['Adrian', 'Simon']599>>> d.get('lastname', 'nonexistent')600'nonexistent'601>>> d.setlist('lastname', ['Holovaty', 'Willison'])",,"This class exists to solve the irritating problem raised by cgi.parse_qs,602which returns a list for every key, even though most Web forms submit603single name-value pairs.",,"This class exists to solve the irritating problem raised by cgi.parse_qs,604which returns a list for every key, even though most Web forms submit605single name-value pairs.",,,,,,,,,,,,6061,MultiValueField,"Aggregate the logic of multiple Fields.607 608Its clean() method takes a ""decompressed"" list of values, which are then609cleaned into a single value according to self.fields. Each value in610this list is cleaned by the corresponding field -- the first value is611cleaned by the first field, the second value is cleaned by the second612field, etc. Once all fields are cleaned, the list of clean values is613""compressed"" into a single value.614 615Subclasses should not have to implement clean(). Instead, they must616implement compress(), which takes a list of valid values and returns a617""compressed"" version of those values -- a single value.618 619You'll probably want to use this with MultiWidget.",Aggregate the logic of multiple Fields.,,,"Its clean() method takes a ""decompressed"" list of values, which are then620cleaned into a single value according to self.fields. Each value in621this list is cleaned by the corresponding field -- the first value is622cleaned by the first field, the second value is cleaned by the second623field, etc. Once all fields are cleaned, the list of clean values is624""compressed"" into a single value.",,,,,,,,You'll probably want to use this with MultiWidget.,,,,,"Subclasses should not have to implement clean(). Instead, they must625implement compress(), which takes a list of valid values and returns a626""compressed"" version of those values -- a single value.",6271,MultiWidget,"A widget that is composed of multiple widgets.628 629In addition to the values added by Widget.get_context(), this widget630adds a list of subwidgets to the context as widget['subwidgets'].631These can be looped over and rendered like normal widgets.632 633You'll probably want to use this class with MultiValueField.",A widget that is composed of multiple widgets.,,,"In addition to the values added by Widget.get_context(), this widget634adds a list of subwidgets to the context as widget['subwidgets'].635These can be looped over and rendered like normal widgets.",,,,,,,,You'll probably want to use this class with MultiValueField.,,,,,,6361,MyModel,Model subclass with a custom base using metaclass.,Model subclass with a custom base using metaclass.,,,,,,,,,,,,,,,,,6371,NestedObjectsTests,Tests for ``NestedObject`` utility collection.,Tests for ``NestedObject`` utility collection.,,,,,,,,,,,,,,,,,6381,Operation,"Base class for migration operations.639 640It's responsible for both mutating the in-memory model state641(see db/migrations/state.py) to represent what it performs, as well642as actually performing it against a live database.643 644Note that some operations won't modify memory state at all (e.g. data645copying operations), and some will need their modifications to be646optionally specified by the user (e.g. custom Python code snippets)647 648Due to the way this class deals with deconstruction, it should be649considered immutable.",Base class for migration operations.,,,"It's responsible for both mutating the in-memory model state650(see db/migrations/state.py) to represent what it performs, as well651as actually performing it against a live database.",,,,,,,,,,"Due to the way this class deals with deconstruction, it should be652considered immutable.",,,,"Note that some operations won't modify memory state at all (e.g. data653copying operations), and some will need their modifications to be654optionally specified by the user (e.g. custom Python code snippets)"6551,OverwritingStorage,"Overwrite existing files instead of appending a suffix to generate an656unused name.","Overwrite existing files instead of appending a suffix to generate an657unused name.",,,,,,,,,,,,,,,,,6581,ParentWithDependentChildren,"Issue #20522659Model where the validation of child foreign-key relationships depends660on validation of the parent","Model where the validation of child foreign-key relationships depends661on validation of the parent",,,,,,,,Issue #20522,,,,"Issue #20522662Model where the validation of child foreign-key relationships depends663on validation of the parent",,,,,6641,Permission,"The permissions system provides a way to assign permissions to specific665users and groups of users.666 667The permission system is used by the Django admin site, but may also be668useful in your own code. The Django admin site uses permissions as follows:669 670    - The ""add"" permission limits the user's ability to view the ""add"" form671      and add an object.672    - The ""change"" permission limits a user's ability to view the change673      list, view the ""change"" form and change an object.674    - The ""delete"" permission limits the ability to delete an object.675    - The ""view"" permission limits the ability to view an object.676 677Permissions are set globally per type of object, not per specific object678instance. It is possible to say ""Mary may change news stories,"" but it's679not currently possible to say ""Mary may change news stories, but only the680ones she created herself"" or ""Mary may only change news stories that have a681certain status or publication date.""682 683The permissions listed above are automatically created for each model.","The permissions system provides a way to assign permissions to specific684users and groups of users.","The permission system is used by the Django admin site, but may also be685useful in your own code. The Django admin site uses permissions as follows:686 687    - The ""add"" permission limits the user's ability to view the ""add"" form688      and add an object.689    - The ""change"" permission limits a user's ability to view the change690      list, view the ""change"" form and change an object.691    - The ""delete"" permission limits the ability to delete an object.692    - The ""view"" permission limits the ability to view an object.",,The permissions listed above are automatically created for each model.,,,,,,,,,,,,,,"Permissions are set globally per type of object, not per specific object693instance. It is possible to say ""Mary may change news stories,"" but it's694not currently possible to say ""Mary may change news stories, but only the695ones she created herself"" or ""Mary may only change news stories that have a696certain status or publication date."""6971,PermissionDeniedBackendTest,Other backends are not checked once a backend raises PermissionDenied,,,,,,,,,,,Other backends are not checked once a backend raises PermissionDenied,,,,,,,6981,PrePopulatedPostLargeSlug,"Regression test for #15938: a large max_length for the slugfield must not699be localized in prepopulated_fields_js.html or it might end up breaking700the javascript (ie, using THOUSAND_SEPARATOR ends up with maxLength=1,000)",,,,,,,,"Regression test for #15938: a large max_length for the slugfield must not701be localized in prepopulated_fields_js.html or it might end up breaking702the javascript (ie, using THOUSAND_SEPARATOR ends up with maxLength=1,000)",Regression test for #15938:,,,,,,,,,7031,ProxyModelInheritanceTests,"Proxy model inheritance across apps can result in migrate not creating the table704for the proxied model (as described in #12286).  This test creates two dummy705apps and calls migrate, then verifies that the table has been created.","Proxy model inheritance across apps can result in migrate not creating the table706for the proxied model (as described in #12286).",,,"This test creates two dummy707apps and calls migrate, then verifies that the table has been created.",,,,,,,,,,,,,,7081,RawPostDataException,"You cannot access raw_post_data from a request that has709multipart/* POST data if it has been accessed via POST,710FILES, etc..","You cannot access raw_post_data from a request that has711multipart/* POST data if it has been accessed via POST,712FILES, etc..",,,"if it has been accessed via POST,713FILES, etc..",,,,,,,"You cannot access raw_post_data from a request that has714multipart/* POST data if it has been accessed via POST,715FILES, etc..",,,,,,,7161,RemoteTestRunner,"Run tests and record everything but don't display anything.717 718The implementation matches the unpythonic coding style of unittest2.",Run tests and record everything but don't display anything.,,,,,,,,,,,,,,The implementation matches the unpythonic coding style of unittest2.,,,7191,RequestFactoryEnvironmentTests,"Regression tests for #8551 and #17067: ensure that environment variables720are set correctly in RequestFactory.","Regression tests for #8551 and #17067: ensure that environment variables721are set correctly in RequestFactory.",,,"ensure that environment variables722are set correctly in RequestFactory.",,,,,,,,,,,,,,7231,ReverseGenericManyToOneDescriptor,"Accessor to the related objects manager on the one-to-many relation created724by GenericRelation.725 726In the example::727 728    class Post(Model):729        comments = GenericRelation(Comment)730 731``post.comments`` is a ReverseGenericManyToOneDescriptor instance.","Accessor to the related objects manager on the one-to-many relation created732by GenericRelation.","In the example::733 734    class Post(Model):735        comments = GenericRelation(Comment)736 737``post.comments`` is a ReverseGenericManyToOneDescriptor instance.",,,,,,,,,,,,,,,,7381,SameAsLookup,"The ""~="" operator is the ""same as"" operator. It tests actual geometric739equality of two features. So if A and B are the same feature,740vertex-by-vertex, the operator returns true.","The ""~="" operator is the ""same as"" operator. It tests actual geometric741equality of two features. So if A and B are the same feature,742vertex-by-vertex, the operator returns true.",,,"The ""~="" operator is the ""same as"" operator. It tests actual geometric743equality of two features. So if A and B are the same feature,744vertex-by-vertex, the operator returns true.",,,,,,,,,,,,,,7451,Serializer,Convert a queryset to JSON.,Convert a queryset to JSON.,,,,,,,,,,,,,,,,,7461,SessionStorage,"Store messages in the session (that is, django.contrib.sessions).","Store messages in the session (that is, django.contrib.sessions).",,,,,,"Store messages in the session (that is, django.contrib.sessions).",,,,,"Store messages in the session (that is, django.contrib.sessions).",,,,,,7471,SessionStore,"A database session store, that handles updating the account ID column748inside the custom session model.","A database session store,",,,"that handles updating the account ID column749inside the custom session model.",,,,,,,,,,,,,,7501,SimpleView,A simple view with a docstring.,A simple view with a docstring.,,,,,,,,,,,,,,,,,7511,SpatialRefSysMixin,"The SpatialRefSysMixin is a class used by the database-dependent752SpatialRefSys objects to reduce redundant code.","The SpatialRefSysMixin is a class used by the database-dependent753SpatialRefSys objects to reduce redundant code.",,,,,"The SpatialRefSysMixin is a class used by the database-dependent754SpatialRefSys objects to reduce redundant code.",,,,,,,,,,,,7551,SplitHiddenDateTimeWidget,"A widget that splits datetime input into two <input type=""hidden""> inputs.","A widget that splits datetime input into two <input type=""hidden""> inputs.",,,,,,,,,,,,,,,,,7561,StaticFilesHandler,"WSGI middleware that intercepts calls to the static files directory, as757defined by the STATIC_URL setting, and serves those files.","WSGI middleware that intercepts calls to the static files directory, as758defined by the STATIC_URL setting, and serves those files.",,"WSGI middleware that intercepts calls to the static files directory, as759defined by the STATIC_URL setting, and serves those files.",,,,,,,,,,,,,,,7601,StrictAssignmentTests,"Should a model do anything special with __setattr__() or descriptors which761raise a ValidationError, a model form should catch the error (#24706).",,,,,,,,"Should a model do anything special with __setattr__() or descriptors which762raise a ValidationError, a model form should catch the error (#24706).",,,,,,,,,,7631,SubCategoryForm,"Subclassing without specifying a Meta on the class will use764the parent's Meta (or the first parent in the MRO if there are765multiple parent classes).",,,,,,,,,,,,,,,,,"Subclassing without specifying a Meta on the class will use766the parent's Meta (or the first parent in the MRO if there are767multiple parent classes).",7681,SuccessMessageMixin,Add a success message on successful form submission.,Add a success message on successful form submission.,,,,,,,,,,,,,,,,,7691,TemplateDoesNotExist,"The exception used when a template does not exist. Optional arguments:770 771backend772    The template backend class used when raising this exception.773 774tried775    A list of sources that were tried when finding the template. This776    is formatted as a list of tuples containing (origin, status), where777    origin is an Origin object or duck type and status is a string with the778    reason the template wasn't found.779 780chain781    A list of intermediate TemplateDoesNotExist exceptions. This is used to782    encapsulate multiple exceptions when loading templates from multiple783    engines.",The exception used when a template does not exist,,"Optional arguments:784 785backend786    The template backend class used when raising this exception.787 788tried789    A list of sources that were tried when finding the template. This790    is formatted as a list of tuples containing (origin, status), where791    origin is an Origin object or duck type and status is a string with the792    reason the template wasn't found.793 794chain795    A list of intermediate TemplateDoesNotExist exceptions. This is used to796    encapsulate multiple exceptions when loading templates from multiple797    engines.",,,,,,,,,,,,,,,7981,TestImageFieldFile,"Custom Field File class that records whether or not the underlying file799was opened.","Custom Field File class that records whether or not the underlying file800was opened.",,,,,,,,,,,,,,,,,8011,TestRouter,Routes to the 'other' database if the model name starts with 'Other'.,,,,Routes to the 'other' database if the model name starts with 'Other'.,,,,,,,,,,,,,,8021,TestUtils,"This __doc__ output is required for testing. I copied this example from803`admindocs` documentation. (TITLE)804 805Display an individual :model:`myapp.MyModel`.806 807**Context**808 809``RequestContext``810 811``mymodel``812    An instance of :model:`myapp.MyModel`.813 814**Template:**815 816:template:`myapp/my_template.html` (DESCRIPTION)817 818some_metadata: some data",,,,,,This __doc__ output is required for testing.,,,"I copied this example from819`admindocs` documentation. (TITLE)820 821Display an individual :model:`myapp.MyModel`.822 823**Context**824 825``RequestContext``826 827``mymodel``828    An instance of :model:`myapp.MyModel`.829 830**Template:**831 832:template:`myapp/my_template.html` (DESCRIPTION)833 834some_metadata: some data",,,,,,,,,8351,UniqueAnchor,"This is a model that can be used as836something for other models to point at","This is a model that can be used as837something for other models to point at",,,,,,,,,,,,,,,,,8381,UpdateError,Occurs if Django tries to update a session that was deleted.,Occurs if Django tries to update a session that was deleted.,,,,,,,,,,,,,,,,,8391,UserCreationForm,"A form that creates a user, with no privileges, from the given username and840password.","A form that creates a user, with no privileges, from the given username and841password.",,"A form that creates a user, with no privileges, from the given username and842password.",,,,,,,,,,,,,,,8431,VariableWrapper,"An adapter class for cursor variables that prevents the wrapped object844from being converted into a string when used to instantiate an OracleParam.845This can be used generally for any other object that should be passed into846Cursor.execute as-is.","An adapter class for cursor variables that prevents the wrapped object847from being converted into a string when used to instantiate an OracleParam.","This can be used generally for any other object that should be passed into848Cursor.execute as-is.",,,,,,,,,,,,,,,,8491,WindowFrame,"Model the frame clause in window expressions. There are two types of frame850clauses which are subclasses, however, all processing and validation (by no851means intended to be complete) is done here. Thus, providing an end for a852frame is optional (the default is UNBOUNDED FOLLOWING, which is the last853row in the frame).",Model the frame clause in window expressions,,,"There are two types of frame854clauses which are subclasses, however, all processing and validation (by no855means intended to be complete) is done here.",,,,,,,,,,,,,"There are two types of frame856clauses which are subclasses, however, all processing and validation (by no857means intended to be complete) is done here.",8581,XFrameOptionsDecoratorsTests,Tests for the X-Frame-Options decorators.,Tests for the X-Frame-Options decorators.,,,,,,,,,,,,,,,,,8591,XFrameOptionsMiddleware,"Set the X-Frame-Options HTTP header in HTTP responses.860 861Do not set the header if it's already set or if the response contains862a xframe_options_exempt value set to True.863 864By default, set the X-Frame-Options header to 'SAMEORIGIN', meaning the865response can only be loaded on a frame within the same site. To prevent the866response from being loaded in a frame in any site, set X_FRAME_OPTIONS in867your project's Django settings to 'DENY'.",,"By default, set the X-Frame-Options header to 'SAMEORIGIN', meaning the868response can only be loaded on a frame within the same site.869 870 871To prevent the872response from being loaded in a frame in any site, set X_FRAME_OPTIONS in873your project's Django settings to 'DENY'.",,,,"Do not set the header if it's already set or if the response contains874a xframe_options_exempt value set to True.875 876By default, set the X-Frame-Options header to 'SAMEORIGIN', meaning the877response can only be loaded on a frame within the same site.878 879 880To prevent the881response from being loaded in a frame in any site, set X_FRAME_OPTIONS in882your project's Django settings to 'DENY'.",Set the X-Frame-Options HTTP header in HTTP responses.,,,,,,,,,,,8832,Audio,"Create an audio object.884 885When this object is returned by an input cell or passed to the886display function, it will result in Audio controls being displayed887in the frontend (only works in the notebook).888 889Parameters890----------891data : numpy array, list, unicode, str or bytes892    Can be one of893 894      * Numpy 1d array containing the desired waveform (mono)895      * Numpy 2d array containing waveforms for each channel.896        Shape=(NCHAN, NSAMPLES). For the standard channel order, see897        http://msdn.microsoft.com/en-us/library/windows/hardware/dn653308(v=vs.85).aspx898      * List of float or integer representing the waveform (mono)899      * String containing the filename900      * Bytestring containing raw PCM data or901      * URL pointing to a file on the web.902 903    If the array option is used, the waveform will be normalized.904 905    If a filename or url is used, the format support will be browser906    dependent.907url : unicode908    A URL to download the data from.909filename : unicode910    Path to a local file to load the data from.911embed : boolean912    Should the audio data be embedded using a data URI (True) or should913    the original source be referenced. Set this to True if you want the914    audio to playable later with no internet connection in the notebook.915 916    Default is `True`, unless the keyword argument `url` is set, then917    default value is `False`.918rate : integer919    The sampling rate of the raw data.920    Only required when data parameter is being used as an array921autoplay : bool922    Set to True if the audio should immediately start playing.923    Default is `False`.924normalize : bool925    Whether audio should be normalized (rescaled) to the maximum possible926    range. Default is `True`. When set to `False`, `data` must be between927    -1 and 1 (inclusive), otherwise an error is raised.928    Applies only when `data` is a list or array of samples; other types of929    audio are never normalized.930 931Examples932--------933::934 935    # Generate a sound936    import numpy as np937    framerate = 44100938    t = np.linspace(0,5,framerate*5)939    data = np.sin(2*np.pi*220*t) + np.sin(2*np.pi*224*t)940    Audio(data,rate=framerate)941 942    # Can also do stereo or more channels943    dataleft = np.sin(2*np.pi*220*t)944    dataright = np.sin(2*np.pi*224*t)945    Audio([dataleft, dataright],rate=framerate)946 947    Audio(""http://www.nch.com.au/acm/8k16bitpcm.wav"")  # From URL948    Audio(url=""http://www.w3schools.com/html/horse.ogg"")949 950    Audio('/path/to/sound.wav')  # From file951    Audio(filename='/path/to/sound.ogg')952 953    Audio(b'RAW_WAV_DATA..)  # From bytes954    Audio(data=b'RAW_WAV_DATA..)955 956See Also957--------958 959See also the ``Audio`` widgets form the ``ipywidget`` package for more flexibility and options.",Create an audio object.,"Examples960--------961::962 963    # Generate a sound964    import numpy as np965    framerate = 44100966    t = np.linspace(0,5,framerate*5)967    data = np.sin(2*np.pi*220*t) + np.sin(2*np.pi*224*t)968    Audio(data,rate=framerate)969 970    # Can also do stereo or more channels971    dataleft = np.sin(2*np.pi*220*t)972    dataright = np.sin(2*np.pi*224*t)973    Audio([dataleft, dataright],rate=framerate)974 975    Audio(""http://www.nch.com.au/acm/8k16bitpcm.wav"")  # From URL976    Audio(url=""http://www.w3schools.com/html/horse.ogg"")977 978    Audio('/path/to/sound.wav')  # From file979    Audio(filename='/path/to/sound.ogg')980 981    Audio(b'RAW_WAV_DATA..)  # From bytes982    Audio(data=b'RAW_WAV_DATA..)","Parameters983----------984data : numpy array, list, unicode, str or bytes985    Can be one of986 987      * Numpy 1d array containing the desired waveform (mono)988      * Numpy 2d array containing waveforms for each channel.989        Shape=(NCHAN, NSAMPLES). For the standard channel order, see990        http://msdn.microsoft.com/en-us/library/windows/hardware/dn653308(v=vs.85).aspx991      * List of float or integer representing the waveform (mono)992      * String containing the filename993      * Bytestring containing raw PCM data or994      * URL pointing to a file on the web.995 996    If the array option is used, the waveform will be normalized.997 998    If a filename or url is used, the format support will be browser999    dependent.1000url : unicode1001    A URL to download the data from.1002filename : unicode1003    Path to a local file to load the data from.1004embed : boolean1005    Should the audio data be embedded using a data URI (True) or should1006    the original source be referenced. Set this to True if you want the1007    audio to playable later with no internet connection in the notebook.1008 1009    Default is `True`, unless the keyword argument `url` is set, then1010    default value is `False`.1011rate : integer1012    The sampling rate of the raw data.1013    Only required when data parameter is being used as an array1014autoplay : bool1015    Set to True if the audio should immediately start playing.1016    Default is `False`.1017normalize : bool1018    Whether audio should be normalized (rescaled) to the maximum possible1019    range. Default is `True`. When set to `False`, `data` must be between1020    -1 and 1 (inclusive), otherwise an error is raised.1021    Applies only when `data` is a list or array of samples; other types of1022    audio are never normalized.","When this object is returned by an input cell or passed to the1023display function, it will result in Audio controls being displayed1024in the frontend (only works in the notebook).",,,,,"See Also1025--------1026 1027See also the ``Audio`` widgets form the ``ipywidget`` package for more flexibility and options.",,,,,,,,,10282,capture_output,context manager for capturing stdout/err,context manager for capturing stdout/err,,,,,,,,,,,,,,,,,10292,CapturingDisplayPublisher,A DisplayPublisher that store,A DisplayPublisher that store,,,,,,,,,,,,,,,,,10302,CellMagicRole,Cross reference role displayed with a %% prefix,Cross reference role displayed with a %% prefix,,,,,,,,,,,,,,,,,10312,DisplayHook,"The custom IPython displayhook to replace sys.displayhook.1032 1033This class does many things, but the basic idea is that it is a callable1034that gets called anytime user code returns a value.",The custom IPython displayhook to replace sys.displayhook.,,,"This class does many things, but the basic idea is that it is a callable1035that gets called anytime user code returns a value.",,,,,,,,,,,,,,10362,DummyMod,"A dummy module used for IPython's interactive module when1037a namespace must be assigned to the module's __dict__.","A dummy module used for IPython's interactive module when1038a namespace must be assigned to the module's __dict__.",,,,,,,,,,,,,,,,,10392,GeoJSON,"GeoJSON expects JSON-able dict1040 1041not an already-serialized JSON string.1042 1043Scalar types (None, number, string) are not allowed, only dict containers.",GeoJSON expects JSON-able dict,,,,,"not an already-serialized JSON string.1044 1045Scalar types (None, number, string) are not allowed, only dict containers.",,,,,"not an already-serialized JSON string.1046 1047Scalar types (None, number, string) are not allowed, only dict containers.",,,,,,,10482,HelpEnd,Transformer for help syntax: obj? and obj??,Transformer for help syntax: obj? and obj??,,,,,,,,,,,,,,,,,10492,HistoryAccessor,"Access the history database without adding to it.1050 1051This is intended for use by standalone history tools. IPython shells use1052HistoryManager, below, which is a subclass of this.",Access the history database without adding to it.,"This is intended for use by standalone history tools. IPython shells use1053HistoryManager, below, which is a subclass of this.",,,,,,,,,,,,,,,,10542,InteractiveShellApp,"A Mixin for applications that start InteractiveShell instances.1055 1056Provides configurables for loading extensions and executing files1057as part of configuring a Shell environment.1058 1059The following methods should be called by the :meth:`initialize` method1060of the subclass:1061 1062  - :meth:`init_path`1063  - :meth:`init_shell` (to be implemented by the subclass)1064  - :meth:`init_gui_pylab`1065  - :meth:`init_extensions`1066  - :meth:`init_code`","A Mixin for applications that start InteractiveShell instances.Provides configurables for loading extensions and executing files1067as part of configuring a Shell environment.",,,"The following methods should be called by the :meth:`initialize` method1068of the subclass:1069 1070  - :meth:`init_path`1071  - :meth:`init_shell` (to be implemented by the subclass)1072  - :meth:`init_gui_pylab`1073  - :meth:`init_extensions`1074  - :meth:`init_code`",,,,,,,,,,,,,"The following methods should be called by the :meth:`initialize` method1075of the subclass:1076 1077  - :meth:`init_path`1078  - :meth:`init_shell` (to be implemented by the subclass)1079  - :meth:`init_gui_pylab`1080  - :meth:`init_extensions`1081  - :meth:`init_code`",10822,IPythonInputSplitter,An input splitter that recognizes all of IPython's special syntax.,An input splitter that recognizes all of IPython's special syntax.,,,,,,,,,,,,,,,,,10832,LazyEvaluate,"This is used for formatting strings with values that need to be updated1084at that time, such as the current time or working directory.",,,,,,"This is used for formatting strings with values that need to be updated1085at that time, such as the current time or working directory.",,,,,"This is used for formatting strings with values that need to be updated1086at that time, such as the current time or working directory.",,,,,,,10872,Magics,"Base class for implementing magic functions.1088 1089Shell functions which can be reached as %function_name. All magic1090functions should accept a string, which they can parse for their own1091needs. This can make some functions easier to type, eg `%cd ../`1092vs. `%cd(""../"")`1093 1094Classes providing magic functions need to subclass this class, and they1095MUST:1096 1097- Use the method decorators `@line_magic` and `@cell_magic` to decorate1098  individual methods as magic functions, AND1099 1100- Use the class decorator `@magics_class` to ensure that the magic1101  methods are properly registered at the instance level upon instance1102  initialization.1103 1104See :mod:`magic_functions` for examples of actual implementation classes.",Base class for implementing magic functions.,"Classes providing magic functions need to subclass this class, and they1105MUST:1106 1107- Use the method decorators `@line_magic` and `@cell_magic` to decorate1108  individual methods as magic functions, AND1109 1110- Use the class decorator `@magics_class` to ensure that the magic1111  methods are properly registered at the instance level upon instance1112  initialization.",,"""All magic functions should accept a string, which they can parse for their own needs. 1113 1114""",,"Shell functions which can be reached as %function_name.1115 1116This can make some functions easier to type, eg `%cd ../`1117vs. `%cd(""../"")`",,,See :mod:`magic_functions` for examples of actual implementation classes.,,"All magic functions should accept a string, which they can parse for their own needs.","Shell functions which can be reached as %function_name.1118 1119This can make some functions easier to type, eg `%cd ../`1120vs. `%cd(""../"")`",,"All magic functions should accept a string, which they can parse for their own needs.",,,,11212,MyFrame,"This is MyFrame.  It just shows a few controls on a wxPanel,1122and has a simple menu.","This is MyFrame.  It just shows a few controls on a wxPanel,1123and has a simple menu.",,,,,,,,,,,,,,,,,11242,Obj,Namespace to hold arbitrary information.,Namespace to hold arbitrary information.,,,,,,,,,,,,,,,,,11252,RichPromptDisplayHook,Subclass of base display hook using coloured prompt,Subclass of base display hook using coloured prompt,,,,,,,,,,,,,,,,,11262,Struct,"A dict subclass with attribute style access.1127 1128This dict subclass has a a few extra features:1129 1130* Attribute style access.1131* Protection of class members (like keys, items) when using attribute1132  style access.1133* The ability to restrict assignment to only existing keys.1134* Intelligent merging.1135* Overloaded operators.",A dict subclass with attribute style access.,,,"This dict subclass has a a few extra features:1136 1137* Attribute style access.1138* Protection of class members (like keys, items) when using attribute1139  style access.1140* The ability to restrict assignment to only existing keys.1141* Intelligent merging.1142* Overloaded operators.",,,,,,,,,,,,,,11432,TBTools,Basic tools used by all traceback printer classes.,Basic tools used by all traceback printer classes.,,,,,,,,,,,,,,,,,11442,TermColors,"Color escape sequences.1145 1146This class defines the escape sequences for all the standard (ANSI?)1147colors in terminals. Also defines a NoColor escape which is just the null1148string, suitable for defining 'dummy' color schemes in terminals which get1149confused by color escapes.1150 1151This class should be used as a mixin for building color schemes.","Color escape sequences.1152 1153This class defines the escape sequences for all the standard (ANSI?)1154colors in terminals. Also defines a NoColor escape which is just the null1155string, suitable for defining 'dummy' color schemes in terminals which get1156confused by color escapes.",This class should be used as a mixin for building color schemes.,,,,,,,,,,This class should be used as a mixin for building color schemes.,,,,,,11572,UserMagics,"Placeholder for user-defined magics to be added at runtime.1158 1159All magics are eventually merged into a single namespace at runtime, but we1160use this class to isolate the magics defined dynamically by the user into1161their own class.",Placeholder for user-defined magics to be added at runtime.,,,"All magics are eventually merged into a single namespace at runtime, but we1162use this class to isolate the magics defined dynamically by the user into1163their own class.",,"All magics are eventually merged into a single namespace at runtime, but we1164use this class to isolate the magics defined dynamically by the user into1165their own class.",,,,,"All magics are eventually merged into a single namespace at runtime, but we1166use this class to isolate the magics defined dynamically by the user into1167their own class.",,,,,,,11682,YouTubeVideo,"Class for embedding a YouTube Video in an IPython session, based on its video id.1169 1170e.g. to embed the video from https://www.youtube.com/watch?v=foo , you would1171do::1172 1173    vid = YouTubeVideo(""foo"")1174    display(vid)1175 1176To start from 30 seconds::1177 1178    vid = YouTubeVideo(""abc"", start=30)1179    display(vid)1180 1181To calculate seconds from time as hours, minutes, seconds use1182:class:`datetime.timedelta`::1183 1184    start=int(timedelta(hours=1, minutes=46, seconds=40).total_seconds())1185 1186Other parameters can be provided as documented at1187https://developers.google.com/youtube/player_parameters#Parameters1188 1189When converting the notebook using nbconvert, a jpeg representation of the video1190will be inserted in the document.","Class for embedding a YouTube Video in an IPython session, based on its video id.","When converting the notebook using nbconvert, a jpeg representation of the video1191will be inserted in the document.1192 1193e.g. to embed the video from https://www.youtube.com/watch?v=foo , you would1194do::1195 1196    vid = YouTubeVideo(""foo"")1197    display(vid)1198 1199To start from 30 seconds::1200 

Showing the first 1,200 of 6170 lines. Download the file for the rest.