diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 7486a4d..e09a150 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,6 +1,7 @@ ## Version 3.0.1 (git master) - fix glib DLL name with Conan [boussaffawalid] +- remove redundant `revalidate` flags from docs [kleisauke] ## Version 3.0.0 (released 28 April 2025) diff --git a/doc/vimage.rst b/doc/vimage.rst index cc204c2..de1118a 100644 --- a/doc/vimage.rst +++ b/doc/vimage.rst @@ -1223,12 +1223,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: csvload_source(source, skip=int, lines=int, whitespace=str, separator=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: csvload_source(source, skip=int, lines=int, whitespace=str, separator=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load csv. Example: - out = pyvips.Image.csvload_source(source, skip=int, lines=int, whitespace=str, separator=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.csvload_source(source, skip=int, lines=int, whitespace=str, separator=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -1246,8 +1246,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -1785,12 +1783,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: fitsload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: fitsload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load FITS from a source. Example: - out = pyvips.Image.fitsload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.fitsload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -1800,8 +1798,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -2009,12 +2005,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: gifload_buffer(buffer, n=int, page=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: gifload_buffer(buffer, n=int, page=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load GIF with libnsgif. Example: - out = pyvips.Image.gifload_buffer(buffer, n=int, page=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.gifload_buffer(buffer, n=int, page=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -2028,19 +2024,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: gifload_source(source, n=int, page=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: gifload_source(source, n=int, page=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load gif from source. Example: - out = pyvips.Image.gifload_source(source, n=int, page=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.gifload_source(source, n=int, page=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -2054,8 +2048,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -2263,12 +2255,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: heifload_buffer(buffer, page=int, n=int, thumbnail=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: heifload_buffer(buffer, page=int, n=int, thumbnail=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load a HEIF image. Example: - out = pyvips.Image.heifload_buffer(buffer, page=int, n=int, thumbnail=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.heifload_buffer(buffer, page=int, n=int, thumbnail=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -2286,19 +2278,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: heifload_source(source, page=int, n=int, thumbnail=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: heifload_source(source, page=int, n=int, thumbnail=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load a HEIF image. Example: - out = pyvips.Image.heifload_source(source, page=int, n=int, thumbnail=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.heifload_source(source, page=int, n=int, thumbnail=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -2316,8 +2306,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -2763,12 +2751,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: jp2kload_buffer(buffer, page=int, oneshot=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: jp2kload_buffer(buffer, page=int, oneshot=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load JPEG2000 image. Example: - out = pyvips.Image.jp2kload_buffer(buffer, page=int, oneshot=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.jp2kload_buffer(buffer, page=int, oneshot=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -2782,19 +2770,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: jp2kload_source(source, page=int, oneshot=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: jp2kload_source(source, page=int, oneshot=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load JPEG2000 image. Example: - out = pyvips.Image.jp2kload_source(source, page=int, oneshot=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.jp2kload_source(source, page=int, oneshot=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -2808,8 +2794,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -2931,12 +2915,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: jpegload_buffer(buffer, shrink=int, autorotate=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: jpegload_buffer(buffer, shrink=int, autorotate=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load jpeg from buffer. Example: - out = pyvips.Image.jpegload_buffer(buffer, shrink=int, autorotate=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.jpegload_buffer(buffer, shrink=int, autorotate=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -2952,19 +2936,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: jpegload_source(source, shrink=int, autorotate=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: jpegload_source(source, shrink=int, autorotate=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load image from jpeg source. Example: - out = pyvips.Image.jpegload_source(source, shrink=int, autorotate=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.jpegload_source(source, shrink=int, autorotate=bool, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -2980,8 +2962,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -3161,12 +3141,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: jxlload_buffer(buffer, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: jxlload_buffer(buffer, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load JPEG-XL image. Example: - out = pyvips.Image.jxlload_buffer(buffer, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.jxlload_buffer(buffer, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -3180,19 +3160,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: jxlload_source(source, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: jxlload_source(source, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load JPEG-XL image. Example: - out = pyvips.Image.jxlload_source(source, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.jxlload_source(source, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -3206,8 +3184,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -3365,12 +3341,12 @@ Autogenerated methods :rtype: Image :raises Error: - .. staticmethod:: magickload(filename, density=str, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: magickload(filename, density=str, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load file with ImageMagick. Example: - out = pyvips.Image.magickload(filename, density=str, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.magickload(filename, density=str, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param filename: Filename to load from :type filename: str @@ -3386,19 +3362,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: magickload_buffer(buffer, density=str, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: magickload_buffer(buffer, density=str, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load buffer with ImageMagick. Example: - out = pyvips.Image.magickload_buffer(buffer, density=str, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.magickload_buffer(buffer, density=str, page=int, n=int, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -3414,8 +3388,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -3919,12 +3891,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: matrixload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: matrixload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load matrix. Example: - out = pyvips.Image.matrixload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.matrixload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -3934,8 +3906,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -4263,12 +4233,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: niftiload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: niftiload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load NIfTI volumes. Example: - out = pyvips.Image.niftiload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.niftiload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -4278,8 +4248,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -4359,12 +4327,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: openslideload_source(source, level=int, autocrop=bool, associated=str, attach_associated=bool, rgb=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: openslideload_source(source, level=int, autocrop=bool, associated=str, attach_associated=bool, rgb=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load source with OpenSlide. Example: - out = pyvips.Image.openslideload_source(source, level=int, autocrop=bool, associated=str, attach_associated=bool, rgb=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.openslideload_source(source, level=int, autocrop=bool, associated=str, attach_associated=bool, rgb=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -4384,8 +4352,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -4425,12 +4391,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: pdfload_buffer(buffer, page=int, n=int, dpi=float, scale=float, background=list[float], password=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: pdfload_buffer(buffer, page=int, n=int, dpi=float, scale=float, background=list[float], password=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load PDF from buffer. Example: - out = pyvips.Image.pdfload_buffer(buffer, page=int, n=int, dpi=float, scale=float, background=list[float], password=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.pdfload_buffer(buffer, page=int, n=int, dpi=float, scale=float, background=list[float], password=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -4452,19 +4418,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: pdfload_source(source, page=int, n=int, dpi=float, scale=float, background=list[float], password=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: pdfload_source(source, page=int, n=int, dpi=float, scale=float, background=list[float], password=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load PDF from source. Example: - out = pyvips.Image.pdfload_source(source, page=int, n=int, dpi=float, scale=float, background=list[float], password=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.pdfload_source(source, page=int, n=int, dpi=float, scale=float, background=list[float], password=str, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -4486,8 +4450,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -4561,12 +4523,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: pngload_buffer(buffer, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: pngload_buffer(buffer, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load png from buffer. Example: - out = pyvips.Image.pngload_buffer(buffer, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.pngload_buffer(buffer, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -4578,19 +4540,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: pngload_source(source, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: pngload_source(source, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load png from source. Example: - out = pyvips.Image.pngload_source(source, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.pngload_source(source, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -4602,8 +4562,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -4737,12 +4695,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: ppmload_buffer(buffer, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: ppmload_buffer(buffer, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load ppm from buffer. Example: - out = pyvips.Image.ppmload_buffer(buffer, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.ppmload_buffer(buffer, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -4752,19 +4710,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: ppmload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: ppmload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load ppm from source. Example: - out = pyvips.Image.ppmload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.ppmload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -4774,8 +4730,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -4933,12 +4887,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: radload_buffer(buffer, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: radload_buffer(buffer, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load rad from buffer. Example: - out = pyvips.Image.radload_buffer(buffer, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.radload_buffer(buffer, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -4948,19 +4902,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: radload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: radload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load rad from source. Example: - out = pyvips.Image.radload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.radload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -4970,8 +4922,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -5743,12 +5693,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: svgload_buffer(buffer, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: svgload_buffer(buffer, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load SVG with rsvg. Example: - out = pyvips.Image.svgload_buffer(buffer, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.svgload_buffer(buffer, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -5768,19 +5718,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: svgload_source(source, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: svgload_source(source, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load svg from source. Example: - out = pyvips.Image.svgload_source(source, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.svgload_source(source, dpi=float, scale=float, unlimited=bool, stylesheet=str, high_bitdepth=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -5800,8 +5748,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -6037,12 +5983,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: tiffload_buffer(buffer, page=int, n=int, autorotate=bool, subifd=int, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: tiffload_buffer(buffer, page=int, n=int, autorotate=bool, subifd=int, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load tiff from buffer. Example: - out = pyvips.Image.tiffload_buffer(buffer, page=int, n=int, autorotate=bool, subifd=int, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.tiffload_buffer(buffer, page=int, n=int, autorotate=bool, subifd=int, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -6062,19 +6008,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: tiffload_source(source, page=int, n=int, autorotate=bool, subifd=int, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: tiffload_source(source, page=int, n=int, autorotate=bool, subifd=int, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load tiff from source. Example: - out = pyvips.Image.tiffload_source(source, page=int, n=int, autorotate=bool, subifd=int, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.tiffload_source(source, page=int, n=int, autorotate=bool, subifd=int, unlimited=bool, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -6094,8 +6038,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -6379,12 +6321,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: vipsload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: vipsload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load vips from source. Example: - out = pyvips.Image.vipsload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.vipsload_source(source, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -6394,8 +6336,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] @@ -6469,12 +6409,12 @@ Autogenerated methods :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: webpload_buffer(buffer, page=int, n=int, scale=float, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: webpload_buffer(buffer, page=int, n=int, scale=float, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load webp from buffer. Example: - out = pyvips.Image.webpload_buffer(buffer, page=int, n=int, scale=float, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.webpload_buffer(buffer, page=int, n=int, scale=float, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param buffer: Buffer to load from :type buffer: str @@ -6490,19 +6430,17 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] :raises Error: - .. staticmethod:: webpload_source(source, page=int, n=int, scale=float, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool, flags=bool) + .. staticmethod:: webpload_source(source, page=int, n=int, scale=float, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], flags=bool) Load webp from source. Example: - out = pyvips.Image.webpload_source(source, page=int, n=int, scale=float, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn], revalidate=bool) + out = pyvips.Image.webpload_source(source, page=int, n=int, scale=float, memory=bool, access=Union[str, Access], fail_on=Union[str, FailOn]) :param source: Source to load from :type source: Source @@ -6518,8 +6456,6 @@ Autogenerated methods :type access: Union[str, Access] :param fail_on: Error level to fail on :type fail_on: Union[str, FailOn] - :param revalidate: Don't use a cached result for this operation - :type revalidate: bool :param flags: enable output: Flags for this file :type flags: bool :rtype: Image or list[Image, Dict[str, mixed]] diff --git a/pyvips/voperation.py b/pyvips/voperation.py index 4e2db57..4d1b37d 100644 --- a/pyvips/voperation.py +++ b/pyvips/voperation.py @@ -17,6 +17,7 @@ _MODIFY = 128 # for VipsOperationFlags +_OPERATION_NOCACHE = 4 _OPERATION_DEPRECATED = 8 @@ -417,6 +418,13 @@ def generate_sphinx(operation_name): raise Error('No such operator.', f'operator "{operation_name}" is deprecated') + # drop "revalidate" flag from buffer loaders and operations marked + # "nocache" as they are already uncached + doc_optional_input = [name for name in intro.doc_optional_input if + name != 'revalidate' or + ('_buffer' not in operation_name and + (intro.flags & _OPERATION_NOCACHE) == 0)] + if intro.member_x is not None: result = '.. method:: ' else: @@ -424,7 +432,7 @@ def generate_sphinx(operation_name): args = [] args += intro.method_args args += [x + '=' + GValue.gtype_to_python(intro.details[x]['type']) - for x in intro.doc_optional_input] + for x in doc_optional_input] args += [x + '=bool' for x in intro.doc_optional_output] result += operation_name + '(' + ", ".join(args) + ')\n\n' @@ -443,11 +451,11 @@ def generate_sphinx(operation_name): args = [] args += intro.method_args args += [x + '=' + GValue.gtype_to_python(intro.details[x]['type']) - for x in intro.doc_optional_input] + for x in doc_optional_input] result += ', '.join(args) result += ')\n\n' - for name in intro.method_args + intro.doc_optional_input: + for name in intro.method_args + doc_optional_input: details = intro.details[name] result += f':param {name}: {details["blurb"]}\n' result += (f':type {name}: '