https://github.com/hernanatn/sobrecargar.py

Sobrecarga de métodos y funciones para Python 3.
https://github.com/hernanatn/sobrecargar.py

Last synced: 16 days ago
JSON representation

Sobrecarga de métodos y funciones para Python 3.

• Host: GitHub
• URL: https://github.com/hernanatn/sobrecargar.py
• Owner: Hernanatn
• License: other
• Created: 2023-10-07T17:09:49.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-10-16T04:44:21.000Z (3 months ago)
• Last Synced: 2024-11-18T15:47:46.702Z (about 1 month ago)
• Language: Python
• Homepage: https://cajadeideas.ar
• Size: 213 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE

Awesome Lists containing this project

README

        

# Sobrecargar

## Descripción

`sobrecargar` es un módulo de Python que incluye una única clase homonima, la cual provee la implementación de un @decorador universal, que permite definir múltiples versiones de una función o método con diferentes conjuntos de parámetros y tipos. Esto permite crear una sobrecarga de funciones similar a la que se encuentra en otros lenguajes de programación, como C++.

## Instalación

Puede decargar e instalar `sobrecargar` utilizando el manejador de paquetes `PIP`, según se indica a continuación:

**Ejecute** el siguiente comando en la `terminal`:

``` Bash

pip install sobrecargar

``` 

## Uso Básico

### Decorar una función:

Se puede emplear tanto `@sobrecargar` como `@overload` para decorar funciones o métodos.

```python

from sobrecargar import sobrecargar

@sobrecargar

def mi_funcion(parametro1: int, parametro2: str):

    # Código de la primera versión de la función

    ...

@sobrecargar

def mi_funcion(parametro1: float):

    # Código de la segunda versión de la función

    ...

```

### Decorar un método de una clase:

Para decorar métodos internos de clases se debe proveer una firma previa para el tipo.

```python

from sobrecargar import overload # 'ovearload' es un alias pre-definido para 'sobrecargar'

class MiClase: pass #Al proveer firma para la clase, se asegura que `sobrecargar` pueda referenciarla en tiempo de compilación

class MiClase:

    @overload

    def mi_metodo(self, parametro1: int, parametro2: str):

        # Código de la primera versión del método

        ...

    @overload

    def mi_metodo(self, parametro1: float):

        # Código de la segunda versión del método

        ...

```

## Ejemplo de Uso

# Función 'libre'

```python

@overload

def suma(a: int, b: int):

    return a + b

@overload

def suma(a: list[int]):

    return sum([x for x in a])

resultado1 = suma(1, 2)  # Llama a la primera versión de la función suma, con parámetros a y b : int

>> 3

resultado2 = suma([1,2,3,4,5])  # Llama a la segunda versión de la función suma, con parámetro a : List[int]

>> 15

```

**Nota**: Esta documentación es un resumen de alto nivel. Para obtener más detalles sobre la implementación y el uso avanzado, se recomienda consultar el código fuente, la documentación provista y realizar pruebas adicionales.

## [Documentación](/docs)