conan入门(三十六):在set_version方法中从pom.xml中读取版本号实现动态版本定义

2023-12-14 12:38:32

一般情况下，我们通过self.version字段定义conan 包的版本号如下：

class PkgConan(ConanFile):
	name = "pkg"
	version = "1.7.3"

因为版本号是写死的，所以这种方式有局限性：
比如我的java项目中版本号是在pom.xml中定义的，c++项目是java项目的子项目，如果java项目版本号升级了，我每次发布java版本的时候都需要手工修改conanfile.py中的self.version才能让c++子项目的版本号与java项目的版本号同步更新，虽然不复杂，但增加了维护工作量，容易忘记。
所以如果conanfile.py中定义的版本号能自动与pom.xml中的版本号同步是最好的解决办法，
conanfile.py中的 set_version方法用就是用于实现动态版本号定义。
这个方法在官方文档中有说明和示例，只不过官方示例只是从读取一个简单的包含了版本号的文本文件，赋值给self.version。（参见《set_version()》）

但对于pom.xml，就复杂些，需要引入xml相关的包，解析xml，然后读取version节点,pom.xml文件内容示例如下：

<?xml version="1.0"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>com.gitee.l0km</groupId>
		<artifactId>facedb</artifactId>
		<version>3.1.1-SNAPSHOT</version>
		<relativePath>..</relativePath>
	</parent>
	<artifactId>facedb-rpc-cpp</artifactId>
	<name>facedb C++ client</name>
</project>

如下在conanfile.py中实现 set_version方法，方法中解析pom.xml，从中读取parent/version节点获取版本号。

from conan import ConanFile
import xml.etree.ElementTree as ET
import os

class Pkg(ConanFile):
    # 将包含版本号的pom.xml与conanfile.py放在一起
    exports = "pom.xml"
    exports_sources = "CMakeLists.txt","src/CMakeLists.txt", "src/facedbclient/*","src/facedbclient/CMakeLists.txt","src/gfaux_tools/*","src/gfaux_tools/CMakeLists.txt","src/test/*","src/test/CMakeLists.txt", "cmake/*.cmake.in"

    def set_version(self):
        # 从pom.xml中解析 parent/version 节点获取pom.xml中定义的版本
        root = ET.parse(os.path.join(self.recipe_folder,"pom.xml")).getroot()
        # 将版本号转为小写如果1.0.0-snapshot,因为conan不允许版本号中有大写字母
        # pom.xml中有namespace定义，所以要加{*}指定任意namespace
        self.version = root.find("{*}parent/{*}version").text.lower()
        self.output.info(f"version:{self.version}")

完整的conanfile.py代码示例参见
https://gitee.com/l0km/facedb/blob/master/facedb-rpc-cpp/conanfile.py

参考资料

《set_version()》
《xml.etree.ElementTree》
《Reading Maven Pom xml in Python》

conan系列文章

文章来源:https://blog.csdn.net/10km/article/details/134861926
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若内容造成侵权/违法违规/事实不符，请联系我的编程经验分享网邮箱：veading@qq.com进行投诉反馈，一经查实，立即删除！