.. _jgdv._abstract.protocols.str:
   
    
============================
jgdv._abstract.protocols.str
============================
  

   
.. py:module:: jgdv._abstract.protocols.str

.. autoapi-nested-parse::

   Adapated from typeshed, this is a full protocol of the stdlib `str`.

       
 

   
 

 

 
   
 
   
Type Aliases
------------

.. autoapisummary::
   
   jgdv._abstract.protocols.str.ReadableBuffer
   jgdv._abstract.protocols.str.SupportsIndex
   jgdv._abstract.protocols.str._FormatMapMapping
   jgdv._abstract.protocols.str._TranslateTable

        

           

 
 

 
 

Protocols
---------

.. autoapisummary::

   jgdv._abstract.protocols.str.String_p

           
   
             
  
           
 
  
           
 
      
 
Module Contents
===============

 
.. py:data:: ReadableBuffer
   :type:  TypeAlias
   :value: Any


 
.. py:data:: SupportsIndex
   :type:  TypeAlias
   :value: Any


 
.. py:data:: _FormatMapMapping
   :type:  TypeAlias
   :value: Any


 
.. py:data:: _TranslateTable
   :type:  TypeAlias
   :value: Any


 
 

.. _jgdv._abstract.protocols.str.String_p:
   
.. py:class:: String_p
   
   Bases: :py:obj:`Protocol` 
     
   Base class for protocol classes.

   Protocol classes are defined as::

       class Proto(Protocol):
           def meth(self) -> int:
               ...

   Such classes are primarily used with static type checkers that recognize
   structural subtyping (static duck-typing).

   For example::

       class C:
           def meth(self) -> int:
               return 0

       def func(x: Proto) -> int:
           return x.meth()

       func(C())  # Passes static type check

   See PEP 544 for details. Protocol classes decorated with
   @typing.runtime_checkable act as simple-minded runtime protocols that check
   only the presence of given attributes, ignoring their type signatures.
   Protocol classes can be generic, they are defined as::

       class GenProto[T](Protocol):
           def meth(self) -> T:
               ...

   
      
   .. py:method:: capitalize() -> <Unknown>
      


      
   .. py:method:: casefold() -> <Unknown>
      


      
   .. py:method:: center(width, fillchar = ' ', /) -> <Unknown>
      


      
   .. py:method:: count(sub, start = ..., end = ..., /) -> <Unknown>
      


      
   .. py:method:: encode(encoding = 'utf-8', errors = 'strict') -> <Unknown>
      


      
   .. py:method:: endswith(suffix, start = ..., end = ...) -> <Unknown>
      


      
   .. py:method:: expandtabs(tabsize = 8) -> <Unknown>
      


      
   .. py:method:: find(sub, start = ..., end = ..., /) -> <Unknown>
      


      
   .. py:method:: format(*args, **kwargs) -> <Unknown>
      


      
   .. py:method:: format_map(mapping, /) -> <Unknown>
      


      
   .. py:method:: index(sub, start = ..., end = ..., /) -> <Unknown>
      


      
   .. py:method:: isalnum() -> <Unknown>
      


      
   .. py:method:: isalpha() -> <Unknown>
      


      
   .. py:method:: isascii() -> <Unknown>
      


      
   .. py:method:: isdecimal() -> <Unknown>
      


      
   .. py:method:: isdigit() -> <Unknown>
      


      
   .. py:method:: isidentifier() -> <Unknown>
      


      
   .. py:method:: islower() -> <Unknown>
      


      
   .. py:method:: isnumeric() -> <Unknown>
      


      
   .. py:method:: isprintable() -> <Unknown>
      


      
   .. py:method:: isspace() -> <Unknown>
      


      
   .. py:method:: istitle() -> <Unknown>
      


      
   .. py:method:: isupper() -> <Unknown>
      


      
   .. py:method:: join(iterable, /) -> <Unknown>
      


      
   .. py:method:: ljust(width, fillchar = ' ', /) -> <Unknown>
      


      
   .. py:method:: lower() -> <Unknown>
      


      
   .. py:method:: lstrip(chars = None, /) -> <Unknown>
      


      
   .. py:method:: maketrans(x: dict[str | int, String_p.maketrans._T], /) -> dict[int, String_p.maketrans._T]
                  maketrans(x: str, y: str, /) -> dict[int, int]               
                  maketrans(x: str, y: str, z: str, /) -> dict[int, jgdv.Maybe[int]]               
      :staticmethod:
      


      
   .. py:method:: partition(sep, /) -> <Unknown>
      


      
   .. py:method:: removeprefix(prefix, /) -> <Unknown>
      


      
   .. py:method:: removesuffix(suffix, /) -> <Unknown>
      


      
   .. py:method:: replace(old, new, /, count = -1) -> <Unknown>
      


      
   .. py:method:: rfind(sub, start = ..., end = ..., /) -> <Unknown>
      


      
   .. py:method:: rindex(sub, start = ..., end = ..., /) -> <Unknown>
      


      
   .. py:method:: rjust(width, fillchar = ' ', /) -> <Unknown>
      


      
   .. py:method:: rpartition(sep, /) -> <Unknown>
      


      
   .. py:method:: rsplit(sep = None, maxsplit = -1) -> <Unknown>
      


      
   .. py:method:: rstrip(chars = None, /) -> <Unknown>
      


      
   .. py:method:: split(sep = None, maxsplit = -1) -> <Unknown>
      


      
   .. py:method:: splitlines(keepends = False) -> <Unknown>
      


      
   .. py:method:: startswith(prefix, start = ..., end = ..., /) -> <Unknown>
      


      
   .. py:method:: strip(chars = None, /) -> <Unknown>
      


      
   .. py:method:: swapcase() -> <Unknown>
      


      
   .. py:method:: title() -> <Unknown>
      


      
   .. py:method:: translate(table, /) -> <Unknown>
      


      
   .. py:method:: upper() -> <Unknown>
      


      
   .. py:method:: zfill(width, /) -> <Unknown>