1+ <!doctype html>
2+ < html lang ="en ">
3+ < head >
4+ < meta charset ="utf-8 ">
5+ < meta name ="viewport " content ="width=device-width, initial-scale=1, minimum-scale=1 " />
6+ < meta name ="generator " content ="pdoc 0.10.0 " />
7+ < title > ogr.deprecation API documentation</ title >
8+ < meta name ="description " content ="" />
9+ < link rel ="preload stylesheet " as ="style " href ="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css " integrity ="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs= " crossorigin >
10+ < link rel ="preload stylesheet " as ="style " href ="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css " integrity ="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg= " crossorigin >
11+ < link rel ="stylesheet preload " as ="style " href ="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css " crossorigin >
12+ < style > : root {--highlight-color : # fe9flex {display : flex !important }body {line-height : 1.5em }# content {padding : 20px }# sidebar {padding : 30px ;overflow : hidden}# sidebar > * : last-child {margin-bottom : 2cm }.http-server-breadcrumbs {font-size : 130% ;margin : 0 0 15px 0 }# footer {font-size : .75em ;padding : 5px 30px ;border-top : 1px solid # dddtext-align : right}# footer p {margin : 0 0 0 1em ;display : inline-block}# footer p : last-child {margin-right : 30px }h1 , h2 , h3 , h4 , h5 {font-weight : 300 }h1 {font-size : 2.5em ;line-height : 1.1em }h2 {font-size : 1.75em ;margin : 1em 0 .50em 0 }h3 {font-size : 1.4em ;margin : 25px 0 10px 0 }h4 {margin : 0 ;font-size : 105% }h1 : target , h2 : target , h3 : target , h4 : target , h5 : target , h6 : target {background : var (--highlight-color );padding : .2em 0 }a {color : # 058text-decoration : none;transition : color .3s ease-in-out}a : hover {color : # e82title code {font-weight : bold}h2 [id ^= "header-" ]{margin-top : 2em }.ident {color : # 900pre code {background : # f8f8f8font-size : .8em ;line-height : 1.4em }code {background : # f2f2f1padding : 1px 4px ;overflow-wrap : break-word}h1 code {background : transparent}pre {background : # f8f8f8border : 0 ;border-top : 1px solid # cccborder-bottom : 1px solid # cccmargin : 1em 0 ;padding : 1ex }# http-server-module-list {display : flex;flex-flow : column}# http-server-module-list div {display : flex}# http-server-module-list dt {min-width : 10% }# http-server-module-list p {margin-top : 0 }.toc ul , # index {list-style-type : none;margin : 0 ;padding : 0 }# index code {background : transparent}# index h3 {border-bottom : 1px solid # ddd# index ul {padding : 0 }# index h4 {margin-top : .6em ;font-weight : bold}@media (min-width : 200ex ){# index .two-column {column-count : 2 }}@media (min-width : 300ex ){# index .two-column {column-count : 3 }}dl {margin-bottom : 2em }dl dl : last-child {margin-bottom : 4em }dd {margin : 0 0 1em 3em }# header-classes + dl > dd {margin-bottom : 3em }dd dd {margin-left : 2em }dd p {margin : 10px 0 }.name {background : # eeefont-weight : bold;font-size : .85em ;padding : 5px 10px ;display : inline-block;min-width : 40% }.name : hover {background : # e0e0e0dt : target .name {background : var (--highlight-color )}.name > span : first-child {white-space : nowrap}.name .class > span : nth-child (2 ){margin-left : .4em }.inherited {color : # 999border-left : 5px solid # eeepadding-left : 1em }.inheritance em {font-style : normal;font-weight : bold}.desc h2 {font-weight : 400 ;font-size : 1.25em }.desc h3 {font-size : 1em }.desc dt code {background : inherit}.source summary , .git-link-div {color : # 666text-align : right;font-weight : 400 ;font-size : .8em ;text-transform : uppercase}.source summary > * white-space : nowrap;cursor : pointer}.git-link {color : inherit;margin-left : 1em }.source pre {max-height : 500px ;overflow : auto;margin : 0 }.source pre code {font-size : 12px ;overflow : visible}.hlist {list-style : none}.hlist li {display : inline}.hlist li : after {content : ',\2002' }.hlist li : last-child : after {content : none}.hlist .hlist {display : inline;padding-left : 1em }img {max-width : 100% }td {padding : 0 .5em }.admonition {padding : .1em .5em ;margin-bottom : 1em }.admonition-title {font-weight : bold}.admonition .note , .admonition .info , .admonition .important {background : # aefadmonition .todo , .admonition .versionadded , .admonition .tip , .admonition .hint {background : # dfdadmonition .warning , .admonition .versionchanged , .admonition .deprecated {background : # fd4admonition .error , .admonition .danger , .admonition .caution {background : lightpink}</ style >
13+ < style media ="screen and (min-width: 700px) "> @media screen and (min-width : 700px ){# sidebar {width : 30% ;height : 100vh ;overflow : auto;position : sticky;top : 0 }# content {width : 70% ;max-width : 100ch ;padding : 3em 4em ;border-left : 1px solid # dddpre code {font-size : 1em }.item .name {font-size : 1em }main {display : flex;flex-direction : row-reverse;justify-content : flex-end}.toc ul ul , # index ul {padding-left : 1.5em }.toc > ul > li {margin-top : .5em }}</ style >
14+ < style media ="print "> @media print{# sidebar h1 {page-break-before : always}.source {display : none}}@media print{* background : transparent !important ;color : # 000!important ;box-shadow : none !important ;text-shadow : none !important }a [href ]: after {content : " (" attr (href) ")" ;font-size : 90% }a [href ][title ]: after {content : none}abbr [title ]: after {content : " (" attr (title) ")" }.ir a : after , a [href ^= "javascript:" ]: after , a [href ^= "#" ]: after {content : "" }pre , blockquote {border : 1px solid # 999page-break-inside : avoid}thead {display : table-header-group}tr , img {page-break-inside : avoid}img {max-width : 100% !important }@page {margin : 0.5cm }p , h2 , h3 {orphans : 3 ;widows : 3 }h1 , h2 , h3 , h4 , h5 , h6 {page-break-after : avoid}}</ style >
15+ < script defer src ="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js " integrity ="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8= " crossorigin > </ script >
16+ < script > window . addEventListener ( 'DOMContentLoaded' , ( ) => hljs . initHighlighting ( ) ) </ script >
17+ </ head >
18+ < body >
19+ < main >
20+ < article id ="content ">
21+ < header >
22+ < h1 class ="title "> Module < code > ogr.deprecation</ code > </ h1 >
23+ </ header >
24+ < section id ="section-intro ">
25+ < details class ="source ">
26+ < summary >
27+ < span > Expand source code</ span >
28+ </ summary >
29+ < pre > < code class ="python "> # Copyright Contributors to the Packit project.
30+ # SPDX-License-Identifier: MIT
31+
32+ from deprecated import deprecated
33+
34+
35+ def deprecate_and_set_removal(since: str, remove_in: str, message: str):
36+ """
37+ Decorator for deprecating functions in ogr.
38+
39+ Args:
40+ since: Indicates a version since which is attribute deprecated.
41+ remove_in: Indicates a version in which the attribute will be removed.
42+ message: Message to be included with deprecation.
43+
44+ Returns:
45+ Decorator.
46+ """
47+ return deprecated(
48+ version=since,
49+ reason=f"will be removed in {remove_in}: {message}",
50+ )</ code > </ pre >
51+ </ details >
52+ </ section >
53+ < section >
54+ </ section >
55+ < section >
56+ </ section >
57+ < section >
58+ < h2 class ="section-title " id ="header-functions "> Functions</ h2 >
59+ < dl >
60+ < dt id ="ogr.deprecation.deprecate_and_set_removal "> < code class ="name flex ">
61+ < span > def < span class ="ident "> deprecate_and_set_removal</ span > </ span > (< span > since: str, remove_in: str, message: str)</ span >
62+ </ code > </ dt >
63+ < dd >
64+ < div class ="desc "> < p > Decorator for deprecating functions in ogr.</ p >
65+ < h2 id ="args "> Args</ h2 >
66+ < dl >
67+ < dt > < strong > < code > since</ code > </ strong > </ dt >
68+ < dd > Indicates a version since which is attribute deprecated.</ dd >
69+ < dt > < strong > < code > remove_in</ code > </ strong > </ dt >
70+ < dd > Indicates a version in which the attribute will be removed.</ dd >
71+ < dt > < strong > < code > message</ code > </ strong > </ dt >
72+ < dd > Message to be included with deprecation.</ dd >
73+ </ dl >
74+ < h2 id ="returns "> Returns</ h2 >
75+ < p > Decorator.</ p > </ div >
76+ < details class ="source ">
77+ < summary >
78+ < span > Expand source code</ span >
79+ </ summary >
80+ < pre > < code class ="python "> def deprecate_and_set_removal(since: str, remove_in: str, message: str):
81+ """
82+ Decorator for deprecating functions in ogr.
83+
84+ Args:
85+ since: Indicates a version since which is attribute deprecated.
86+ remove_in: Indicates a version in which the attribute will be removed.
87+ message: Message to be included with deprecation.
88+
89+ Returns:
90+ Decorator.
91+ """
92+ return deprecated(
93+ version=since,
94+ reason=f"will be removed in {remove_in}: {message}",
95+ )</ code > </ pre >
96+ </ details >
97+ </ dd >
98+ </ dl >
99+ </ section >
100+ < section >
101+ </ section >
102+ </ article >
103+ < nav id ="sidebar ">
104+ < h1 > Index</ h1 >
105+ < div class ="toc ">
106+ < ul > </ ul >
107+ </ div >
108+ < ul id ="index ">
109+ < li > < h3 > Super-module</ h3 >
110+ < ul >
111+ < li > < code > < a title ="ogr " href ="index.html "> ogr</ a > </ code > </ li >
112+ </ ul >
113+ </ li >
114+ < li > < h3 > < a href ="#header-functions "> Functions</ a > </ h3 >
115+ < ul class ="">
116+ < li > < code > < a title ="ogr.deprecation.deprecate_and_set_removal " href ="#ogr.deprecation.deprecate_and_set_removal "> deprecate_and_set_removal</ a > </ code > </ li >
117+ </ ul >
118+ </ li >
119+ </ ul >
120+ </ nav >
121+ </ main >
122+ < footer id ="footer ">
123+ < p > Generated by < a href ="https://pdoc3.github.io/pdoc " title ="pdoc: Python API documentation generator "> < cite > pdoc</ cite > 0.10.0</ a > .</ p >
124+ </ footer >
125+ </ body >
126+ </ html >
0 commit comments