This document is for an old version of Python that is no longer supported. You should upgrade and read the documentação do Python para versão estável atual.

# Análise de argumentos e construção de valores

Essas funções são úteis ao criar suas próprias funções e métodos. Informações adicionais e exemplos estão disponíveis em Estendendo e Incorporando o Interpretador Python.

As três primeiras funções descritas, `PyArg_ParseTuple()`, `PyArg_ParseTupleAndKeywords()`, e `PyArg_Parse()`, fazem uso do formato string que são usados para informar a função sobre os argumentos esperados. O formato string faz uso de uma mesma sintaxe para cada uma dessas funções.

Uma string consiste em zero ou mais “unidades de formato”. Uma unidade de formato descreve um objeto Python; geralmente é um único caractere ou uma sequência entre parênteses de unidades de formato. Com algumas exceções, uma unidade de formato que não é uma sequência entre parênteses normalmente corresponde a um único argumento de endereço para essas funções. Na descrição a seguir, o formulário citado é a unidade de formato; A entrada em parênteses ( ) é o tipo de objeto Python que corresponde à unidade de formato; E a entrada em colchetes [ ] é o tipo da variável(s) C cujo endereço deve ser passado.

These formats allow accessing an object as a contiguous chunk of memory. You don’t have to provide raw storage for the returned unicode or bytes area. Also, you won’t have to release any memory yourself, except with the `es`, `es#`, `et` and `et#` formats.

`s` (string or Unicode) [const char *]

  Convert a Python string or Unicode object to a C pointer to a character string. You must not provide storage for the string itself; a pointer to an existing string is stored into the character pointer variable whose address you pass. The C string is NUL-terminated. The Python string must not contain embedded NUL bytes; if it does, a `TypeError` exception is raised. Unicode objects are converted to C strings using the default encoding. If this conversion fails, a `UnicodeError` is raised.

`s#` (string, Unicode or any read buffer compatible object) [const char *, int (or `Py_ssize_t`, see below)]

  This variant on `s` stores into two C variables, the first one a pointer to a character string, the second one its length. In this case the Python string may contain embedded null bytes. Unicode objects pass back a pointer to the default encoded string version of the object if such a conversion is possible. All other read-buffer compatible objects pass back a reference to the raw internal data representation.

  Starting with Python 2.5 the type of the length argument can be controlled by defining the macro `PY_SSIZE_T_CLEAN` before including `Python.h`. If the macro is defined, length is a `Py_ssize_t` rather than an int.

`s*` (string, Unicode, or any buffer compatible object) [Py_buffer]

  Similar to `s#`, this code fills a Py_buffer structure provided by the caller. The buffer gets locked, so that the caller can subsequently use the buffer even inside a `Py_BEGIN_ALLOW_THREADS` block; the caller is responsible for calling `PyBuffer_Release` with the structure after it has processed the data.

  Novo na versão 2.6.

`z` (string, Unicode or `None`) [const char *]

  Like `s`, but the Python object may also be `None`, in which case the C pointer is set to NULL.

`z#` (string, Unicode, `None` or any read buffer compatible object) [const char *, int]

  This is to `s#` as `z` is to `s`.

`z*` (string, Unicode, `None` or any buffer compatible object) [Py_buffer]

  This is to `s*` as `z` is to `s`.

  Novo na versão 2.6.

`u` (Unicode) [Py_UNICODE *]

  Convert a Python Unicode object to a C pointer to a NUL-terminated buffer of 16-bit Unicode (UTF-16) data. As with `s`, there is no need to provide storage for the Unicode data buffer; a pointer to the existing Unicode data is stored into the `Py_UNICODE` pointer variable whose address you pass.

`u#` (Unicode) [Py_UNICODE *, int]

  This variant on `u` stores into two C variables, the first one a pointer to a Unicode data buffer, the second one its length. Non-Unicode objects are handled by interpreting their read-buffer pointer as pointer to a `Py_UNICODE` array.

`es` (string, Unicode or character buffer compatible object) [const char *encoding, char **buffer]

  This variant on `s` is used for encoding Unicode and objects convertible to Unicode into a character buffer. It only works for encoded data without embedded NUL bytes.

  This format requires two arguments. The first is only used as input, and must be a `const char*` which points to the name of an encoding as a NUL-terminated string, or NULL, in which case the default encoding is used. An exception is raised if the named encoding is not known to Python. The second argument must be a `char**`; the value of the pointer it references will be set to a buffer with the contents of the argument text. The text will be encoded in the encoding specified by the first argument.

  `PyArg_ParseTuple()` alocará um buffer do tamanho necessário, copiará os dados codificados nesse buffer e ajustará *buffer para referenciar o armazenamento recém-alocado. O chamador é responsável por chamar `PyMem_Free()` para liberar o buffer alocado após o uso.

`et` (string, Unicode or character buffer compatible object) [const char *encoding, char **buffer]

  Same as `es` except that 8-bit string objects are passed through without recoding them. Instead, the implementation assumes that the string object uses the encoding passed in as parameter.

`es#` (string, Unicode or character buffer compatible object) [const char *encoding, char **buffer, int *buffer_length]

  This variant on `s#` is used for encoding Unicode and objects convertible to Unicode into a character buffer. Unlike the `es` format, this variant allows input data which contains NUL characters.

  It requires three arguments. The first is only used as input, and must be a `const char*` which points to the name of an encoding as a NUL-terminated string, or NULL, in which case the default encoding is used. An exception is raised if the named encoding is not known to Python. The second argument must be a `char**`; the value of the pointer it references will be set to a buffer with the contents of the argument text. The text will be encoded in the encoding specified by the first argument. The third argument must be a pointer to an integer; the referenced integer will be set to the number of bytes in the output buffer.

  Há dois modos de operação:

  If *buffer points a NULL pointer, the function will allocate a buffer of the needed size, copy the encoded data into this buffer and set *buffer to reference the newly allocated storage. The caller is responsible for calling `PyMem_Free()` to free the allocated buffer after usage.

  If *buffer points to a non-NULL pointer (an already allocated buffer), `PyArg_ParseTuple()` will use this location as the buffer and interpret the initial value of *buffer_length as the buffer size. It will then copy the encoded data into the buffer and NUL-terminate it. If the buffer is not large enough, a `TypeError` will be set. Note: starting from Python 3.6 a `ValueError` will be set.

  Em ambos os casos, o *buffer_length é definido como o comprimento dos dados codificados sem o byte NUL à direita.

`et#` (string, Unicode or character buffer compatible object) [const char *encoding, char **buffer, int *buffer_length]

  Same as `es#` except that string objects are passed through without recoding them. Instead, the implementation assumes that the string object uses the encoding passed in as parameter.

`b` (integer) [unsigned char]

  Converte um inteiro Python não negativo em um inteiro pequeno não assinado (unsigned tiny int), armazenado em um `unsigned char` do C

`B` (integer) [unsigned char]

  Converte um inteiro Python para um pequeno inteiro (tiny int) sem verificação de estouro, armazenado em um `unsigned char` do C.

  Novo na versão 2.3.

`h` (integer) [short int]

  Converte um inteiro Python para um `short int` do C.

`H` (integer) [unsigned short int]

  Converte um inteiro Python para um `unsigned short int` do C, sem verificação de estouro.

  Novo na versão 2.3.

`i` (integer) [int]

  Converte um inteiro Python para um `int` simples do C.

`I` (integer) [unsigned int]

  Converte um inteiro Python para um `unsigned int` do C, sem verificação de estouro.

  Novo na versão 2.3.

`l` (integer) [long int]

  Converte um inteiro Python para um `long int` do C.

`k` (integer) [unsigned long]

  Convert a Python integer or long integer to a C `unsigned long` without overflow checking.

  Novo na versão 2.3.

`L` (integer) [PY_LONG_LONG]

  Convert a Python integer to a C `long long`. This format is only available on platforms that support `long long` (or `_int64` on Windows).

`K` (integer) [unsigned PY_LONG_LONG]

  Convert a Python integer or long integer to a C `unsigned long long` without overflow checking. This format is only available on platforms that support `unsigned long long` (or `unsigned _int64` on Windows).

  Novo na versão 2.3.

`n` (integer) [Py_ssize_t]

  Convert a Python integer or long integer to a C `Py_ssize_t`.

  Novo na versão 2.5.

`c` (string of length 1) [char]

  Convert a Python character, represented as a string of length 1, to a C `char`.

`f` (float) [float]

  Converte um número de ponto flutuante Python para um `float` do C.

`d` (float) [double]

  Converte um número de ponto flutuante Python para um `double` do C.

`D` (complex) [Py_complex]

  Converte um número complexo Python para uma estrutura C `Py_complex`

`O` (objeto) [PyObject*]

  Store a Python object (without any conversion) in a C object pointer. The C program thus receives the actual object that was passed. The object’s reference count is not increased. The pointer stored is not NULL.

`O!` (objeto) [typeobject, PyObject *]

  Armazena um objeto Python em um ponteiro de objeto C. Isso é similar `O`, mas usa dois argumentos C: o primeiro é o endereço de um objeto do tipo Python, o segundo é um endereço da variável C (de tipo `PyObject*`) no qual o ponteiro do objeto está armazenado. Se o objeto Python não tiver o tipo necessário, `TypeError` é levantado.

`O&` (objeto) [converter, anything]

  Convert a Python object to a C variable through a converter function. This takes two arguments: the first is a function, the second is the address of a C variable (of arbitrary type), converted to `void *`. The converter function in turn is called as follows:

      status = converter(object, address);

  where object is the Python object to be converted and address is the `void*` argument that was passed to the `PyArg_Parse*()` function. The returned status should be `1` for a successful conversion and `0` if the conversion has failed. When the conversion fails, the converter function should raise an exception and leave the content of address unmodified.

`S` (string) [PyStringObject *]

  Like `O` but requires that the Python object is a string object. Raises `TypeError` if the object is not a string object. The C variable may also be declared as `PyObject*`.

`U` (Unicode string) [PyUnicodeObject *]

  Like `O` but requires that the Python object is a Unicode object. Raises `TypeError` if the object is not a Unicode object. The C variable may also be declared as `PyObject*`.

`t#` (read-only character buffer) [char *, int]

  Like `s#`, but accepts any object which implements the read-only buffer interface. The `char*` variable is set to point to the first byte of the buffer, and the `int` is set to the length of the buffer. Only single-segment buffer objects are accepted; `TypeError` is raised for all others.

`w` (read-write character buffer) [char *]

  Similar to `s`, but accepts any object which implements the read-write buffer interface. The caller must determine the length of the buffer by other means, or use `w#` instead. Only single-segment buffer objects are accepted; `TypeError` is raised for all others.

`w#` (read-write character buffer) [char *, Py_ssize_t]

  Like `s#`, but accepts any object which implements the read-write buffer interface. The `char *` variable is set to point to the first byte of the buffer, and the `Py_ssize_t` is set to the length of the buffer. Only single-segment buffer objects are accepted; `TypeError` is raised for all others.

`w*` (read-write byte-oriented buffer) [Py_buffer]

  This is to `w` what `s*` is to `s`.

  Novo na versão 2.6.

`(items)` (tuple) [matching-items]

  O objeto deve ser uma sequência Python cujo comprimento seja o número de unidades de formato em items. Os argumentos C devem corresponder às unidades de formato individuais em items. As unidades de formato para sequências podem ser aninhadas.

  Nota

  Prior to Python version 1.5.2, this format specifier only accepted a tuple containing the individual parameters, not an arbitrary sequence. Code which previously caused `TypeError` to be raised here may now proceed without an exception. This is not expected to be a problem for existing code.

It is possible to pass Python long integers where integers are requested; however no proper range checking is done — the most significant bits are silently truncated when the receiving field is too small to receive the value (actually, the semantics are inherited from downcasts in C — your mileage may vary).

Alguns outros caracteres possuem significados na string de formatação. Isso pode não ocorrer dentro de parênteses aninhados. Eles são:

`|`

  Indicates that the remaining arguments in the Python argument list are optional. The C variables corresponding to optional arguments should be initialized to their default value — when an optional argument is not specified, `PyArg_ParseTuple()` does not touch the contents of the corresponding C variable(s).

`:`

  A lista de unidades de formatação acaba aqui; a string após os dois pontos é usada como o nome da função nas mensagens de erro (o “valor associado” da exceção que `PyArg_ParseTuple()` levanta).

`;`

  A lista de unidades de formatação acaba aqui; a string após o ponto e vírgula é usada como a mensagem de erro ao invés da mensagem de erro padrão. `:` e `;` se excluem mutuamente.

Note que quaisquer referências a objeto Python que são fornecidas ao chamador são referências emprestadas; não decremente a contagem de referências delas!

Argumentos adicionais passados para essas funções devem ser endereços de variáveis cujo tipo é determinado pela string de formatação; estes são usados para armazenar valores vindos da tupla de entrada. Existem alguns casos, como descrito na lista de unidades de formatação acima, onde esses parâmetros são usados como valores de entrada; eles devem concordar com o que é especificado para a unidade de formatação correspondente nesse caso.

Para a conversão funcionar, o objeto arg deve corresponder ao formato e o formato deve estar completo. Em caso de sucesso, as funções `PyArg_Parse*()` retornam verdadeiro, caso contrário retornam falso e levantam uma exceção apropriada. Quando as funções `PyArg_Parse*()` falham devido a uma falha de conversão em uma das unidades de formatação, as variáveis nos endereços correspondentes àquela unidade e às unidades de formatação seguintes são deixadas intocadas.

int `PyArg_ParseTuple`(PyObject *args, const char *format, ...)

  Analisa os parâmetros de uma função que recebe apenas parâmetros posicionais em variáveis locais. Retorna verdadeiro em caso de sucesso; em caso de falha, retorna falso e levanta a exceção apropriada.

int `PyArg_VaParse`(PyObject *args, const char *format, va_list vargs)

  Idêntico a `PyArg_ParseTuple()`, exceto que aceita uma va_list ao invés de um número variável de argumentos.

int `PyArg_ParseTupleAndKeywords`(PyObject *args, PyObject *kw, const char *format, char *keywords[], ...)

  Parse the parameters of a function that takes both positional and keyword parameters into local variables. Returns true on success; on failure, it returns false and raises the appropriate exception.

int `PyArg_VaParseTupleAndKeywords`(PyObject *args, PyObject *kw, const char *format, char *keywords[], va_list vargs)

  Idêntico a `PyArg_ParseTupleAndKeywords()`, exceto que aceita uma va_list ao invés de um número variável de argumentos.

int `PyArg_Parse`(PyObject *args, const char *format, ...)

  Function used to deconstruct the argument lists of “old-style” functions — these are functions which use the `METH_OLDARGS` parameter parsing method. This is not recommended for use in parameter parsing in new code, and most code in the standard interpreter has been modified to no longer use this for that purpose. It does remain a convenient way to decompose other tuples, however, and may continue to be used for that purpose.

int `PyArg_UnpackTuple`(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)

  Uma forma mais simples de recuperar parâmetros que não usa a string de formatação para especificar os tipos dos argumentos. Funções que usam esse método para recuperar seus parâmetros devem ser declaradas como `METH_VARARGS` em tabelas de função ou método. A tupla contendo os parâmetros reais deve ser passada como args; ela deve ser realmente uma tupla. O comprimento da tupla deve ser pelo menos min e não mais que max; min e max podem ser iguais. Argumentos adicionais devem ser passados para a função, cada qual deve ser um ponteiro para uma variável `PyObject*`; estes serão preenchidos com os valores vindos de args; eles vão conter referências emprestadas. As variáveis que corresponderem a parâmetros opcionais não dados por args não serão preenchidas; estas devem ser inicializadas pelo chamador. Essa função retorna verdadeiro em caso de sucesso e falso se args não é uma tupla ou contém o número errado de elementos; uma exceção será definida se houve uma falha.

  Este é um exemplo do uso dessa função, tirado das fontes do módulo auxiliar para referências fracas `_weakref`:

      static PyObject *
      weakref_ref(PyObject *self, PyObject *args)
      {
          PyObject *object;
          PyObject *callback = NULL;
          PyObject *result = NULL;

          if (PyArg_UnpackTuple(args, "ref", 1, 2, &object, &callback)) {
              result = PyWeakref_NewRef(object, callback);
          }
          return result;
      }

  A chamada à `PyArg_UnpackTuple()` neste exemplo é inteiramente equivalente à chamada para `PyArg_ParseTuple()`:

      PyArg_ParseTuple(args, "O|O:ref", &object, &callback)

  Novo na versão 2.2.

  Alterado na versão 2.5: This function used an `int` type for min and max. This might require changes in your code for properly supporting 64-bit systems.

PyObject* `Py_BuildValue`(const char *format, ...)
  Return value: New reference.

  Create a new value based on a format string similar to those accepted by the `PyArg_Parse*()` family of functions and a sequence of values. Returns the value or NULL in the case of an error; an exception will be raised if NULL is returned.

  `Py_BuildValue()` does not always build a tuple. It builds a tuple only if its format string contains two or more format units. If the format string is empty, it returns `None`; if it contains exactly one format unit, it returns whatever object is described by that format unit. To force it to return a tuple of size `0` or one, parenthesize the format string.

  When memory buffers are passed as parameters to supply data to build objects, as for the `s` and `s#` formats, the required data is copied. Buffers provided by the caller are never referenced by the objects created by `Py_BuildValue()`. In other words, if your code invokes `malloc()` and passes the allocated memory to `Py_BuildValue()`, your code is responsible for calling `free()` for that memory once `Py_BuildValue()` returns.

  Na descrição a seguir, a forma entre aspas é a unidade de formatação; a entrada em parênteses (arredondado) é o tipo do objeto Python que a unidade de formatação irá retornar; e a entrada em colchetes [quadrado] é o tipo do(s) valor(es) C a ser(em) passado(s).

  Os caracteres de espaço, tab, dois pontos e vírgula são ignorados em strings de formatação (mas não dentro de unidades de formatação como `s#`). Isso pode ser usado para tornar strings de formatação longas um pouco mais legíveis.

  `s` (string) [char *]

    Convert a null-terminated C string to a Python object. If the C string pointer is NULL, `None` is used.

  `s#` (string) [char *, int]

    Convert a C string and its length to a Python object. If the C string pointer is NULL, the length is ignored and `None` is returned.

  `z` (string or `None`) [char *]

    O mesmo de `s`.

  `z#` (string or `None`) [char *, int]

    O mesmo de `s#`.

  `u` (Unicode string) [Py_UNICODE *]

    Convert a null-terminated buffer of Unicode (UCS-2 or UCS-4) data to a Python Unicode object. If the Unicode buffer pointer is NULL, `None` is returned.

  `u#` (Unicode string) [Py_UNICODE *, int]

    Convert a Unicode (UCS-2 or UCS-4) data buffer and its length to a Python Unicode object. If the Unicode buffer pointer is NULL, the length is ignored and `None` is returned.

  `i` (integer) [int]

    Converte um simples `int` do C em um objeto inteiro do Python.

  `b` (integer) [char]

    Converte um simples `char` do C em um objeto inteiro do Python.

  `h` (integer) [short int]

    Converte um simples `short int` do C em um objeto inteiro do Python.

  `l` (integer) [long int]

    Converte um `long int` do C em um objeto inteiro do Python.

  `B` (integer) [unsigned char]

    Converte um `unsigned char` do C em um objeto inteiro do Python.

  `H` (integer) [unsigned short int]

    Converte um `unsigned short int` do C em um objeto inteiro do Python.

  `I` (integer/long) [unsigned int]

    Convert a C `unsigned int` to a Python integer object or a Python long integer object, if it is larger than `sys.maxint`.

  `k` (integer/long) [unsigned long]

    Convert a C `unsigned long` to a Python integer object or a Python long integer object, if it is larger than `sys.maxint`.

  `L` (long) [PY_LONG_LONG]

    Convert a C `long long` to a Python long integer object. Only available on platforms that support `long long`.

  `K` (long) [unsigned PY_LONG_LONG]

    Convert a C `unsigned long long` to a Python long integer object. Only available on platforms that support `unsigned long long`.

  `n` (int) [Py_ssize_t]

    Convert a C `Py_ssize_t` to a Python integer or long integer.

    Novo na versão 2.5.

  `c` (string of length 1) [char]

    Convert a C `int` representing a character to a Python string of length 1.

  `d` (float) [double]

    Converte um `double` do C em um número ponto flutuante do Python.

  `f` (float) [float]

    Same as `d`.

  `D` (complex) [Py_complex *]

    Converte uma estrutura `Py_complex` do C em um número complexo do Python.

  `O` (objeto) [PyObject*]

    Pass a Python object untouched (except for its reference count, which is incremented by one). If the object passed in is a NULL pointer, it is assumed that this was caused because the call producing the argument found an error and set an exception. Therefore, `Py_BuildValue()` will return NULL but won’t raise an exception. If no exception has been raised yet, `SystemError` is set.

  `S` (objeto) [PyObject *]

    O mesmo que `O`.

  `N` (objeto) [PyObject *]

    Same as `O`, except it doesn’t increment the reference count on the object. Useful when the object is created by a call to an object constructor in the argument list.

  `O&` (objeto) [converter, anything]

    Convert anything to a Python object through a converter function. The function is called with anything (which should be compatible with `void *`) as its argument and should return a “new” Python object, or NULL if an error occurred.

  `(items)` (tuple) [matching-items]

    Converte uma sequência de valores C para uma tupla Python com o mesmo número de itens.

  `[items]` (list) [matching-items]

    Converte uma sequência de valores C para uma lista Python com o mesmo número de itens.

  `{items}` (dictionary) [matching-items]

    Converte uma sequência de valores C para um dicionário Python. Cada par de valores consecutivos do C adiciona um item ao dicionário, servindo como chave e valor, respectivamente.

  If there is an error in the format string, the `SystemError` exception is set and NULL returned.

PyObject* `Py_VaBuildValue`(const char *format, va_list vargs)

  Idêntico a `Py_BuildValue()`, exceto que aceita uma va_list ao invés de um número variável de argumentos.