# pydub-stubs
Pydub version: **0.25.1**
**`pydub-stubs` provides type information for [Pydub].**<br>
Only the public interface is guaranteed to be typed, however there
are type definitions for some private and undocumented functions.
[Pydub]: https://github.com/jiaaro/pydub
```
pip install pydub-stubs
```
<br>
## Anticipated Questions
### Q: Why is <code>AudioSegment.<i>some_effect(...)</i></code> missing?
You need to import it as a function from `pydub.effects`.
### Q: What is `_Metadata` and `_PartialMetadata`?
These are legacy types that have been replaced by the `channels`,
`frame_rate`, and `sample_rate` keyword arguments.
<br>
## Changelog
### Version 0.25.1.1
* **Removed literal type fallback overloads**<br>
The fallbacks removed all the advantages of using literals at all.
* **Modernized the type stubs**<br>
Uses new union syntax, and more. ([#2](https://github.com/clo4/pydub-stubs/pull/2)
and [#3](https://github.com/clo4/pydub-stubs/pull/3) - thanks, [@Viicos](https://github.com/Viicos)!)
* **Add `WavSubChunk`, `WavData`, and undocumented functions**<br>
These previously existed and were available but were untyped. (thanks again, [@Viicos](https://github.com/Viicos)!)
<details>
<summary>Previous versions</summary>
### Version 0.25.1.0
* **Added v0.25.0 features**<br>
This includes `pydub.scipy_effects.eq` and new classmethod parameters.
* **Signatures now use literals where possible**<br>
Overloaded implementations exist as a fallback.
* **Added missing modules**<br>
`pydub.silence` and `pydub.utils`
### Version 0.24.1.9
* **Add undocumented parameter of `AudioSegment.from_file`**<br>
`read_ahead_limit` is absent from the documentation but is a supported
keyword argument.
### Version 0.24.1.8
* **Export other modules**<br>
Adds exports for effects, exceptions, generators, playback, and scipy_effects
### Version 0.24.1.7
* **Added `AudioSegment._spawn` (again)**<br>
This was accidentally removed in an earlier version.
* **Improved `pydub.effects.invert_phase`**<br>
This is technically less accurate as `(0, 0)` is equivalent to `(0, 1)`.
### Version 0.24.1.6
* **Removed testing symbols from `pydub.audio_segment`**<br>
### Version 0.24.1.5
* **Fixed `AudioSegment.export`**<br>
First param is named `out_f` and isn't required.
### Version 0.24.1.4
* **Improved signature of `AudioSegment.from_file`**<br>
The keyword arguments for raw/PCM audio don't require `format` to be set to
either `raw` or `pcm`.
* **Fixed package exports**<br>
Exports `AudioSegment` from `__init__.py`.
### Version 0.24.1.3
* **Fixed overloads of `AudioSegment.fade`**<br>
Exactly two of `start`, `end`, and `duration` must be given.
### Version 0.24.1.2
* **Improved `AudioSegment.fade`**<br>
Changed to use overloads to prevent invalid method calls.
* **Improved `AudioSegment.from_mono_audiosegments`**<br>
Use a positional-only parameter to ensure there's at least 1 argument.
### Version 0.24.1.1
* **Fixed `AudioSegment.__init__`**<br>
Use overloads to model correct parameters.
* **Fixed `AudioSegment._spawn`**<br>
Parameter `overrides` accepts a partial dictionary.
* **Fixed `pydub.scipy_effects.high_pass_filter`**<br>
Parameter `order` should be `int`, not `float`.
### Version 0.24.1.0
Released
</details>
Raw data
{
"_id": null,
"home_page": "https://github.com/clo4/pydub-stubs",
"name": "pydub-stubs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "pydub,types,typing,stubs",
"author": "SeparateRecords",
"author_email": "hey@clo4.net",
"download_url": "https://files.pythonhosted.org/packages/5b/82/deebad108e82fda55b620ab7e13982de1efc1eb17f10b2b9d8a84283f7ec/pydub_stubs-0.25.1.1.tar.gz",
"platform": null,
"description": "# pydub-stubs\n\nPydub version: **0.25.1**\n\n**`pydub-stubs` provides type information for [Pydub].**<br>\nOnly the public interface is guaranteed to be typed, however there\nare type definitions for some private and undocumented functions.\n\n[Pydub]: https://github.com/jiaaro/pydub\n\n```\npip install pydub-stubs\n```\n\n<br>\n\n## Anticipated Questions\n\n### Q: Why is <code>AudioSegment.<i>some_effect(...)</i></code> missing?\n\nYou need to import it as a function from `pydub.effects`.\n\n### Q: What is `_Metadata` and `_PartialMetadata`?\n\nThese are legacy types that have been replaced by the `channels`,\n`frame_rate`, and `sample_rate` keyword arguments.\n\n<br>\n\n## Changelog\n\n### Version 0.25.1.1\n\n* **Removed literal type fallback overloads**<br>\n The fallbacks removed all the advantages of using literals at all.\n\n* **Modernized the type stubs**<br>\n Uses new union syntax, and more. ([#2](https://github.com/clo4/pydub-stubs/pull/2)\n and [#3](https://github.com/clo4/pydub-stubs/pull/3) - thanks, [@Viicos](https://github.com/Viicos)!)\n\n* **Add `WavSubChunk`, `WavData`, and undocumented functions**<br>\n These previously existed and were available but were untyped. (thanks again, [@Viicos](https://github.com/Viicos)!)\n\n<details>\n<summary>Previous versions</summary>\n\n### Version 0.25.1.0\n\n* **Added v0.25.0 features**<br>\n This includes `pydub.scipy_effects.eq` and new classmethod parameters.\n\n* **Signatures now use literals where possible**<br>\n Overloaded implementations exist as a fallback.\n\n* **Added missing modules**<br>\n `pydub.silence` and `pydub.utils`\n\n### Version 0.24.1.9\n\n* **Add undocumented parameter of `AudioSegment.from_file`**<br>\n `read_ahead_limit` is absent from the documentation but is a supported\n keyword argument.\n\n### Version 0.24.1.8\n\n* **Export other modules**<br>\n Adds exports for effects, exceptions, generators, playback, and scipy_effects\n\n### Version 0.24.1.7\n\n* **Added `AudioSegment._spawn` (again)**<br>\n This was accidentally removed in an earlier version.\n\n* **Improved `pydub.effects.invert_phase`**<br>\n This is technically less accurate as `(0, 0)` is equivalent to `(0, 1)`.\n\n### Version 0.24.1.6\n\n* **Removed testing symbols from `pydub.audio_segment`**<br>\n\n### Version 0.24.1.5\n\n* **Fixed `AudioSegment.export`**<br>\n First param is named `out_f` and isn't required.\n\n### Version 0.24.1.4\n\n* **Improved signature of `AudioSegment.from_file`**<br>\n The keyword arguments for raw/PCM audio don't require `format` to be set to\n either `raw` or `pcm`.\n\n* **Fixed package exports**<br>\n Exports `AudioSegment` from `__init__.py`.\n\n### Version 0.24.1.3\n\n* **Fixed overloads of `AudioSegment.fade`**<br>\n Exactly two of `start`, `end`, and `duration` must be given.\n\n### Version 0.24.1.2\n\n* **Improved `AudioSegment.fade`**<br>\n Changed to use overloads to prevent invalid method calls.\n\n* **Improved `AudioSegment.from_mono_audiosegments`**<br>\n Use a positional-only parameter to ensure there's at least 1 argument.\n\n### Version 0.24.1.1\n\n* **Fixed `AudioSegment.__init__`**<br>\n Use overloads to model correct parameters.\n\n* **Fixed `AudioSegment._spawn`**<br>\n Parameter `overrides` accepts a partial dictionary.\n\n* **Fixed `pydub.scipy_effects.high_pass_filter`**<br>\n Parameter `order` should be `int`, not `float`.\n\n### Version 0.24.1.0\n\nReleased\n\n</details>\n",
"bugtrack_url": null,
"license": "ISC",
"summary": "Stub-only package containing type information for pydub",
"version": "0.25.1.1",
"project_urls": {
"Homepage": "https://github.com/clo4/pydub-stubs",
"Repository": "https://github.com/clo4/pydub-stubs"
},
"split_keywords": [
"pydub",
"types",
"typing",
"stubs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fcef8df7a84ef4e7a45b1f0eae80bc229a10aa10397e4d1eff7b07de863f6987",
"md5": "ec55cdcbceee18c8aec2963568602be9",
"sha256": "8cd0c0b73c8d89c8273e3a500b542a8cf150346a61f35191e9d59cc2f5ba6c1b"
},
"downloads": -1,
"filename": "pydub_stubs-0.25.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec55cdcbceee18c8aec2963568602be9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 8553,
"upload_time": "2023-09-25T15:12:37",
"upload_time_iso_8601": "2023-09-25T15:12:37.092208Z",
"url": "https://files.pythonhosted.org/packages/fc/ef/8df7a84ef4e7a45b1f0eae80bc229a10aa10397e4d1eff7b07de863f6987/pydub_stubs-0.25.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5b82deebad108e82fda55b620ab7e13982de1efc1eb17f10b2b9d8a84283f7ec",
"md5": "c21d821c2ae1a2182a7796291648a7c3",
"sha256": "4a7a783e0455d2b7dcc3034f3dc21aaee284413751aa9705357017931d257bd1"
},
"downloads": -1,
"filename": "pydub_stubs-0.25.1.1.tar.gz",
"has_sig": false,
"md5_digest": "c21d821c2ae1a2182a7796291648a7c3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 7639,
"upload_time": "2023-09-25T15:12:38",
"upload_time_iso_8601": "2023-09-25T15:12:38.445255Z",
"url": "https://files.pythonhosted.org/packages/5b/82/deebad108e82fda55b620ab7e13982de1efc1eb17f10b2b9d8a84283f7ec/pydub_stubs-0.25.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 15:12:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "clo4",
"github_project": "pydub-stubs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pydub-stubs"
}
JSON
