28 noviembre 2024
Los desarrolladores pueden encontrarse en situaciones en las que ya tienen una biblioteca de C# bien establecida y probada que realiza sus funciones de manera excelente. Sin embargo, sus clientes trabajan en un entorno Python y necesitan acceso a la funcionalidad de esta biblioteca. En tales casos, los desarrolladores deben encontrar formas de integrar, haciendo que la biblioteca de C# sea accesible para su uso en Python. En este artículo, examinaremos dos enfoques para resolver esta tarea: el wrapping y la conversión de código, y discutiremos sus ventajas y desventajas. Esto te ayudará a elegir el método más adecuado y garantizar un acceso fácil a la funcionalidad de tu biblioteca de C# en Python.
Como se mencionó anteriormente, existen dos métodos principales para integrar el código de C# en el entorno de Python: el wrapping y la conversión de código.
Vamos a echar un vistazo más de cerca a cada uno de estos métodos.
Convertir código entre lenguajes de programación puede ser una tarea desafiante, especialmente cuando los lenguajes tienen diferentes paradigmas y características sintácticas. Sin embargo, muchas construcciones básicas de C# y Python son similares, por lo que el proceso de conversión, en casos simples, se reduce a cambios de sintaxis y la adaptación de ciertos conceptos.
Ejemplo de una biblioteca de C# (MyLibrary.cs)
using System;
namespace MyLibrary
{
public class Greeting
{
public string SayHello(string name)
{
return $"Hello, {name}!";
}
}
}
Traducción de la biblioteca a Python (mylibrary.py)
class Greeting:
def say_hello(self, name):
return f"Hello, {name}!"
Ejemplo de uso de la biblioteca traducida en un proyecto de Python
# Importamos nuestra clase
from mylibrary import Greeting
# Crear una instancia de la clase Greeting
greet = Greeting()
# Usar el método say_hello
message = greet.say_hello("World")
print(message)
En un ejemplo tan simple, la conversión parece muy atractiva, ¿verdad? Pero vamos a echar un vistazo a las ventajas y desventajas de este método.
Por ejemplo, convertir el siguiente código a Python sería muy desafiante:
using System;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
namespace MyLibrary
{
public class Greeting
{
public string SayHello(string name)
{
var tree = CSharpSyntaxTree.ParseText($"public class Hello {{ public string Name => \"{name}\"; }}");
var root = (CompilationUnitSyntax)tree.GetRoot();
var classDeclaration = (ClassDeclarationSyntax)root.Members[0];
var className = classDeclaration.Identifier.Text;
return $"Parsed class name: {className}";
}
}
}
Muy a menudo, los problemas de intensidad de trabajo, rendimiento y dependencias externas pueden volverse críticos, lo que lleva a considerar otro método para integrar bibliotecas de C# en Python: crear un wrapper.
La envoltura de código C# implica la creación de una interfaz que vincule el código C# con Python, utilizando bibliotecas o herramientas especializadas. Esto permite llamar a métodos escritos en C# directamente desde el código Python. La ventaja de este enfoque es que no requiere reescribir el código existente, ahorrando tiempo y esfuerzo; el código C# original permanece sin cambios. Además, puedes aprovechar todas las capacidades del ecosistema .NET sin preocuparte por portar estas funciones a Python.
Existen varios métodos para envolver código C#, siendo el más popular el uso de la biblioteca Python.NET y herramientas especializadas como nuestro CodePorting.Wrapper Cs2Python.
La biblioteca C# mencionada anteriormente MyLibrary se puede usar en Python de la siguiente manera:
import clr
clr.AddReference("MyLibrary.dll")
from MyLibrary import Greeting
greet = Greeting()
message = greet.SayHello("World")
print(message)
Si hay dependencias en Microsoft.CodeAnalysis, la situación se vuelve más compleja:
import clr
# Agregar todas las dependencias
clr.AddReference("Microsoft.CodeAnalysis.dll")
clr.AddReference("Microsoft.CodeAnalysis.CSharp.dll")
...
clr.AddReference("System.Collections.Immutable.dll")
clr.AddReference("MyLibrary.dll")
from MyLibrary import Greeting
greet = Greeting()
message = greet.SayHello("World")
print(message)
La necesidad de conectar explícitamente dependencias externas y otras limitaciones, como las dificultades para pasar ciertos tipos de datos, puede complicar el uso de la biblioteca Python.NET para integrar el código C#. En tales casos, vale la pena considerar herramientas alternativas que puedan ofrecer soluciones más convenientes y automatizadas.
CodePorting.Wrapper Cs2Python proporciona una forma conveniente de integrar una biblioteca de C# en Python mediante la creación de una extensión estándar de Python en forma de un paquete Wheel (WHL), que se puede instalar fácilmente a través de pip y utilizar en proyectos de Python. Esta herramienta genera automáticamente una capa intermedia que vincula el código de C# con Python. Además, todas las dependencias de la biblioteca de C# se incluyen automáticamente en el paquete.
El uso de la biblioteca MyLibrary envuelta con CodePorting.Wrapper Cs2Python en ambos casos se verá así:
from mylibrary import Greeting
greet = Greeting()
message = greet.say_hello("World")
print(message)
Como puedes ver, esto replica exactamente el ejemplo de uso en el caso de la conversión completa de código. Sin embargo, no tuvimos que convertir el código de Microsoft.CodeAnalysis a Python ni encontrar su equivalente.
Ahora vamos a considerar las ventajas y desventajas de integrar código de C# en Python usando wrapping.
pip hace que el proceso sea simple e intuitivo. Esto permite a los usuarios integrar y utilizar fácilmente la funcionalidad de la biblioteca en sus proyectos sin requerir conocimientos técnicos profundos.Integrar bibliotecas de C# en Python permite usar eficazmente el código existente de C# en proyectos de Python. La elección entre wrapping y conversión de código depende de las necesidades específicas del proyecto. El wrapping permite usar rápida y fácilmente las bibliotecas de C# en Python, minimizando el tiempo y el esfuerzo. La conversión de código requiere más recursos, pero puede proporcionar una integración más profunda.
La elección correcta del método de integración te ayudará a maximizar el uso de los recursos y a alcanzar tus objetivos.