version-0.77 > version
version-0.77
CPANで確認する
Other versions:
version-0.74
version-0.70
Source
編集

名前

version - Perl extension for Version Objects

version - バージョンオブジェクトのための Perl エクステンション

概要

  # Parsing version strings (decimal or dotted-decimal)

  use version 0.77; # get latest bug-fixes and API
  $ver = version->parse($string)

  # Declaring a dotted-decimal $VERSION (keep on one line!)

  use version 0.77; our $VERSION = version->declare("v1.2.3"); # formal
  use version 0.77; our $VERSION = qv("v1.2.3");               # shorthand
  use version 0.77; our $VERSION = qv("v1.2_3");               # alpha

  # Declaring an old-style decimal $VERSION (use quotes!)

  use version 0.77; our $VERSION = version->parse("1.0203");   # formal
  use version 0.77; our $VERSION = version->parse("1.02_03");  # alpha

  # Comparing mixed version styles (decimals, dotted-decimals, objects)

  if ( version->parse($v1) == version->parse($v2) ) {
    # do stuff
  }

  # Sorting mixed version styles

  @ordered = sort { version->parse($a) <=> version->parse($b) } @list;

説明

Version objects were added to Perl in 5.10. This module implements version objects for older version of Perl and provides the version object API for all versions of Perl. All previous releases before 0.74 are deprecated and should not be used due to incompatible API changes. Version 0.77 introduces the new 'parse' and 'declare' methods to standardize usage. You are strongly urged to set 0.77 as a minimum in your code, e.g.

バージョンオブジェクトは 5.10 で Perl に追加されました。 このモジュールは古いバージョンの Perl のためのバージョンオブジェクトを 実装し、全てのバージョンの Perl のためのバージョンオブジェクト API を 提供します。 0.74 以前の全てのリリースは廃止予定で、互換性のない API の変更のため 使われるべきではありません。 バージョン 0.77 から使用法を標準化するために 'parse' と 'declare' が 導入されました。 コードに最低バージョンとして 0.77 を設定することを強く主張します; 例えば

  use version 0.77; # even for Perl v.5.10.0

バージョンオブジェクトの種類

There are two different types of version objects, corresponding to the two different styles of versions in use:

バージョンの二つの異なった使用形式に対応して、二つの異なった バージョンオブジェクトの種類があります。

Decimal Versions

(10 進数バージョン)

The classic floating-point number $VERSION. The advantage to this style is that you don't need to do anything special, just type a number (without quotes) into your source file.

クラシックな浮動小数点数 $VERSION。 この形式の利点は何も特殊なことをする必要はなく、単にソースファイルに 番号を(クォートなしで)書くだけです。

Dotted Decimal Versions

(ドット付き 10 進数バージョン)

The more modern form of version assignment, with 3 (or potentially more) integers seperated by decimal points (e.g. v1.2.3). This is the form that Perl itself has used since 5.6.0 was released. The leading "v" is now strongly recommended for clarity, and will throw a warning in a future release if omitted.

バージョン割り当てのより近代的な形式で、3 (または潜在的にはそれ以上) の 整数を小数点で区切ったものです (例えば v1.2.3)。 これは Perl 自身が 5.6.0 がリリースされてから使っている形式です。 先頭の "v" は現在では明確化のために強く推奨されていて、これがないと 将来のリリースでは警告を投げます。

See "VERSION OBJECT DETAILS" for further information.

さらなる情報については "VERSION OBJECT DETAILS" を参照してください。

バージョンの宣言

If you have a module that uses a decimal $VERSION (floating point), and you do not intend to ever change that, this module is not for you. There is nothing that version.pm gains you over a simple $VERSION assignment:

10 進数 $VERSION (浮動小数点数) を使うモジュールがあって、変更するつもりが ないなら、このモジュールはあなたのためのものではありません。 単純な $VERSION 代入に対して version.pm から得られる利点はありません:

  our $VERSION = 1.02;

Since Perl v5.10.0 includes the version.pm comparison logic anyways, you don't need to do anything at all.

Perl v5.10.0 からはどちらにしろ version.pm 比較ロジックを含んでいるので、 全く何もする必要はありません。

10 進数からドット付き 10 進数へのモジュールの変換方法

If you have used a decimal $VERSION in the past and wish to switch to a dotted-decimal $VERSION, then you need to make a one-time conversion to the new format.

過去に 10 進数 $VERSION を使っていて、ドット付き 10 進数 $VERSION に 切り替えたいなら、一度だけ新しい形式に変換する必要があります。

Important Note: you must ensure that your new $VERSION is numerically greater than your current decimal $VERSION; this is not always obvious. First, convert your old decimal version (e.g. 1.02) to a normalized dotted-decimal form:

重要な注意: 新しい $VERSION は数値的に現在の 10 進数 $VERSION より 大きくしなければなりません; これは常に自明というわけではありません。 最初に、古い 10 進数バージョン (例えば 1.02) をドット付き 10 進数形式に 変換します:

  $ perl -Mversion -e 'print version->parse("1.02")->normal'
  v1.20.0

Then increment any of the dotted-decimal components (v1.20.1 or v1.21.0).

それからドット付き 10 進数の要素のどれかをインクリメントします (v1.20.1 または v1.21.0)。

How to declare() a dotted-decimal version

(ドット付き 10 進数バージョンを declare() する方法)

  use version 0.77; our $VERSION = version->declare("v1.2.3");

The declare() method always creates dotted-decimal version objects. When used in a module, you must put it on the same line as "use version" to ensure that $VERSION is read correctly by PAUSE and installer tools. You should also add 'version' to the 'configure_requires' section of your module metadata file. See instructions in ExtUtils::MakeMaker or Module::Build for details.

declare() メソッドは常にドット付き 10 進数バージョンオブジェクトを 作成します。 モジュールで使うときは、PAUSE やインストーラツールによって $VERSION が 正しく読み込まれるように "use version" と同じ行に 書かなければなりません。 また、モジュールメタデータファイルの 'configure_requires' 節に 'version' を 追加するべきです。 詳細については ExtUtils::MakeMaker または Module::Build の説明を 参照してください。

Important Note: Even if you pass in what looks like a decimal number ("1.2"), a dotted-decimal will be created ("v1.200.0"). To avoid confusion or unintentional errors on older Perls, follow these guidelines:

重要な注意: 例え 10 進数のように見えるもの ("1.2") を渡しても、ドット付き 10 進数 ("v1.200.0") が作成されます。 古い Perl での混乱や意図しないエラーを防ぐために、以下のガイドラインに 従ってください:

  • Always use a dotted-decimal with (at least) three components

    常に (少なくとも) 3 要素のあるドット付き 10 進数を使う

  • Always use a leading-v

    常に先頭の v を使う

  • Always quote the version

    常にバージョンをクォートする

If you really insist on using version.pm with an ordinary decimal version, use parse() instead of declare. See the "PARSING AND COMPARING VERSIONS" for details.

本当に version.pm を普通の 10 進数バージョンで使うことにこだわるなら、 declare の代わりに parse() を使ってください。 詳しくは "PARSING AND COMPARING VERSIONS" を参照してください。

See also "VERSION OBJECT DETAILS" for more on version number conversion, quoting, calculated version numbers and declaring developer or "alpha" version numbers.

バージョン番号変換、クォート、バージョン番号の計算、開発者バージョンや 「α」バージョン番号の宣言に関してさらなる情報は "VERSION OBJECT DETAILS" も 参照してください。

バージョンのパースと比較

If you need to compare version numbers, but can't be sure whether they are expressed as numbers, strings, v-strings or version objects, then you can use version.pm to parse them all into objects for comparison.

バージョン番号を比較する必要があるけれども、バージョン番号が数値なのか 文字列なのかv-文字列なのかバージョンオブジェクトなのか分からない場合、 これら全てを比較のためにパースするために version.pm を使えます。

How to parse() a version

(バージョンの parse() の方法)

The parse() method takes in anything that might be a version and returns a corresponding version object, doing any necessary conversion along the way.

parse() メソッドはバージョンになりそうなもの何でもを取って、必要な 変換を行って、対応するバージョンオブジェクトを返します。

  • Dotted-decimal: bare v-strings (v1.2.3) and strings with more than one decimal point and a leading 'v' ("v1.2.3"); NOTE you can technically use a v-string or strings with a leading-v and only one decimal point (v1.2 or "v1.2"), but you will confuse both yourself and others.

    ドット付き 10 進数: 裸のv-文字列 (v1.2.3) と先頭の 'v' と複数の小数点がある 文字列 ("v1.2.3"); 注意: 技術的には小数点が一つしかないv-文字列や文字列 (v1.2 や "v1.2") も使えますが、自分自身も他人も混乱させます。

  • Decimal: regular decimal numbers (literal or in a string)

    10 進数: (リテラルまたは文字列の中の) 普通の 10 進数

Some examples:

いくつかの例:

  $variable   version->parse($variable)
  ---------   -------------------------
  1.23        v1.230.0
  "1.23"      v1.230.0
  v1.23       v1.23.0
  "v1.23"     v1.23.0
  "1.2.3"     v1.2.3
  "v1.2.3"    v1.2.3

See "VERSION OBJECT DETAILS" for more on version number conversion.

さらなるバージョン番号変換については "VERSION OBJECT DETAILS" を 参照してください。

バージョンオブジェクトの比較の方法

Version objects overload the cmp and <=> operators. Perl automatically generates all of the other comparison operators based on those two so all the normal logical comparisons will work.

バージョンオブジェクトは cmp と <=> の演算子を オーバーロードします。 Perl はこの二つから自動的にその他の比較演算子を生成するので、通常の論理比較は 動作します。

  if ( version->parse($v1) == version->parse($v2) ) {
    # do stuff
  }

If a version object is compared against a non-version object, the non-object term will be converted to a version object using parse(). This may give surprising results:

バージョンオブジェクトがバージョンオブジェクトでないものと比較されると、 非オブジェクト側は parse() を使ってバージョンオブジェクトに変換されます。 これにより驚くべき結果になるかもしれません:

  $v1 = version->parse("v0.95.0");
  $bool = $v1 < 0.96; # FALSE since 0.96 is v0.960.0

Always comparing to a version object will help avoid surprises:

常にバージョンオブジェクトの比較を行うことは驚くことを避ける助けになります:

  $bool = $v1 < version->parse("v0.96.0"); # TRUE

バージョンオブジェクトの詳細

10 進数バージョンとドット付き 10 進数バージョンの等価性

When Perl 5.6.0 was released, the decision was made to provide a transformation between the old-style decimal versions and new-style dotted-decimal versions:

Perl 5.6.0 がリリースされたとき、古い形式の 10 進数バージョンと新しい形式の ドット付き 10 進数バージョンの変換を提供するという決定がなされました:

  5.6.0    == 5.006000
  5.005_04 == 5.5.40

The floating point number is taken and split first on the single decimal place, then each group of three digits to the right of the decimal makes up the next digit, and so on until the number of significant digits is exhausted, plus enough trailing zeros to reach the next multiple of three.

浮動小数点数を取って、まず小数点で分割し、それから小数点の右側の 3 桁の グループ毎に次の数値にして、有効数字がなくなるまでこれを繰り返し、さらに 3 の倍数になるように末尾に 0 を追加します。

This was the method that version.pm adopted as well. Some examples may be helpful:

これは version.pm が採用している方法でもあります。 いくつかの例が助けになるでしょう:

                            equivalent
  decimal    zero-padded    dotted-decimal
  -------    -----------    --------------
  1.2        1.200          v1.200.0
  1.02       1.020          v1.20.0
  1.002      1.002          v1.2.0
  1.0023     1.002300       v1.2.300
  1.00203    1.002030       v1.2.30
  1.002003   1.002003       v1.2.3

クォート規則

Because of the nature of the Perl parsing and tokenizing routines, certain initialization values must be quoted in order to correctly parse as the intended version, especially when using the declare or qv methods. While you do not have to quote decimal numbers when creating version objects, it is always safe to quote all initial values when using version.pm methods, as this will ensure that what you type is what is used.

Perl のパースとトークン化ルーチンの性質により、一部の初期化値は意図している バージョンとして正しくパースするためにクォート されなければなりません; 特に declare や qv メソッドではです。 バージョンオブジェクトを作成するときに 10 進数をクォートする必要がない一方、 version.pm メソッドを使うときに 全ての 初期値をクォートすることは常に 安全です; 入力したものがどのように使われるかを確実にするからです。

Additionally, if you quote your initializer, then the quoted value that goes in will be be exactly what comes out when your $VERSION is printed (stringified). If you do not quote your value, Perl's normal numeric handling comes into play and you may not get back what you were expecting.

さらに、初期化子をクォートする場合、入力 としてクォートされた値は $VERSION が表示される(文字列化される)ときに正確に同じものが 出力 されます。 値をクォートしていない場合、Perl の通常の数値の処理が行われ、想定したものに 戻らないかもしれません。

If you use a mathematic formula that resolves to a floating point number, you are dependent on Perl's conversion routines to yield the version you expect. You are pretty safe by dividing by a power of 10, for example, but other operations are not likely to be what you intend. For example:

浮動小数点数になる数値演算を行った場合、想定したバージョンが生成されるかは Perl の変換ルーチンに依存します。 例えば、10 の累乗で割ることはかなり安全ですが、その他の演算はおそらく 意図した通りにはなりません。 例えば:

  $VERSION = version->new((qw$Revision: 1.4)[1]/10);
  print $VERSION;          # yields 0.14
  $V2 = version->new(100/9); # Integer overflow in decimal number
  print $V2;               # yields something like 11.111.111.100

Perl 5.8.1 and beyond are able to automatically quote v-strings but that is not possible in earlier versions of Perl. In other words:

Perl 5.8.1 以降は自動的にv-文字列をクォートできますが、それ以前の Perl では できません。 言い換えると:

  $version = version->new("v2.5.4");  # legal in all versions of Perl
  $newvers = version->new(v2.5.4);    # legal only in Perl >= 5.8.1

v-文字列はどう?

There are two ways to enter v-strings: a bare number with two or more decimal points, or a bare number with one or more decimal points and a leading 'v' character (also bare). For example:

v-文字列を入力する方法は 2 つあります。 2 つ以上の小数点を持つ裸の数値か、先頭に裸の文字 'v' があって 1 つ以上の小数点を持つ裸の数値です。 例えば:

  $vs1 = 1.2.3; # encoded as \1\2\3
  $vs2 = v1.2;  # encoded as \1\2

However, the use of bare v-strings to initialize version objects is strongly discouraged in all circumstances. Also, bare v-strings are not completely supported in any version of Perl prior to 5.8.1.

しかしながら、バージョンオブジェクトを初期化するために裸のv-文字列を 使用することは、どのような状況であっても 強く 非推奨です。 また、裸の v-文字列は 5.8.1 より前のバージョンの Perl は完全には 対応していません。

If you insist on using bare v-strings with Perl > 5.6.0, be aware of the following limitations:

もし Perl > 5.6.0 で裸のv-文字列を使うことにこだわる場合、以下の制限に 注意してください。

1) For Perl releases 5.6.0 through 5.8.0, the v-string code merely guesses, based on some characteristics of v-strings. You must use a three part version, e.g. 1.2.3 or v1.2.3 in order for this heuristic to be successful.

Perl のリリース 5.6.0 から 5.8.0 において、v-文字列コードはv-文字列の いくつかの特徴に基づいて単に推測を行うのみです。 このヒューリスティクスが成功するためには、必ず 3 つの部分 (例えば 1.2.3 や v1.2.3) のバージョンを使わなければ なりません。

2) For Perl releases 5.8.1 and later, v-strings have changed in the Perl core to be magical, which means that the version.pm code can automatically determine whether the v-string encoding was used.

Perl のリリース 5.8.1 以降では、v-文字列は Perl コアでマジカルになるように 変更されました。 つまり、version.pm コードがv-文字列エンコーディングが使われたかどうかを 自動的に判断できるようになったということです。

3) In all cases, a version created using v-strings will have a stringified form that has a leading 'v' character, for the simple reason that sometimes it is impossible to tell whether one was present initially.

3) 全ての場合で、v-文字列を使って作成されたバージョンは 文字列化形式にしたときに先頭に 'v' の文字がつきます; ときどき、これが先頭に付いていたかを確認することが不可能であるという 単純な理由によります。

αバージョン

For module authors using CPAN, the convention has been to note unstable releases with an underscore in the version string. (See CPAN.) version.pm follows this convention and alpha releases will test as being newer than the more recent stable release, and less than the next stable release. For dotted-decimal versions, only the last element may be separated by an underscore:

CPAN を使用しているモジュール作者の間で、不安定なリリースを示すために バージョン文字列内にアンダースコアを付ける慣習ができています。 (CPAN を参照。) version.pm はこの慣例に従い、αリリースは、その直前の安定リリースよりも 新しく、次の安定リリースよりも小さく判定されます。 ドット付き 10 進数バージョンでは、最後の要素のみが下線で分離されます:

  # Declaring
  use version 0.77; our $VERSION = version->declare("v1.2_3");

  # Parsing
  $v1 = version->parse("v1.2_3");
  $v1 = version->parse("1.002_003");

オブジェクトメソッド

is_alpha()

True if and only if the version object was created with a underscore, e.g.

バージョンオブジェクトが下線付きで作られた場合にのみ真になります; 例えば

  version->parse('1.002_03')->is_alpha;  # TRUE
  version->declare('1.2.3_4')->is_alpha; # TRUE

is_qv()

True only if the version object is a dotted-decimal version, e.g.

バージョンオブジェクトがドット付き 10 進数バージョンの場合にのみ真になります; 例えば

  version->parse('v1.2.0')->is_qv;        # TRUE
  version->declare('v1.2')->is_qv;       # TRUE
  qv('1.2')->is_qv;                      # TRUE
  version->parse('1.2')->is_qv;          # FALSE

normal()

Returns a string with a standard 'normalized' dotted-decimal form with a leading-v and at least 3 components.

先頭の v と最低 3 要素ある標準の「正規化された」ドット付き 10 進数形式の 文字列を返します。

 version->declare('v1.2')->normal;  # v1.2.0
 version->parse('1.2')->normal;     # v1.200.0

numify()

Returns a value representing the object in a pure decimal form without trailing zeroes.

末尾のゼロなしの純粋な 10 進数形式のオブジェクトで表現される値を返します。

 version->declare('v1.2')->numify;  # 1.002
 version->parse('1.2')->numify;     # 1.2

stringify()

Returns a string that is as close to the original representation as possible. If the original representation was a numeric literal, it will be returned the way perl would normally represent it in a string. This method is used whenever a version object is interpolated into a string.

元の表現にできるだけ近い文字列を返します。 元の表現が数値リテラルなら、perl が通常これを文字列で表現する方法で値を 返します。 このメソッドはバージョンオブジェクトが文字列に変換された時に使われます。

 version->declare('v1.2')->stringify;    # v1.2
 version->parse('1.200')->stringify;     # 1.200
 version->parse(1.02_30)->stringify;     # 1.023

エクスポートされる関数

qv()

This function is no longer recommended for use, but is maintained for compatibility with existing code. If you do not want to have it exported to your namespace, use this form:

この関数はもはや使用を推奨されませんが、既にあるコードの互換性のために 保守されています。 名前空間にこれをエクスポートしたくないときは、以下のようにします:

  use version 0.77 ();

作者

John Peacock <[email protected]>

SEE ALSO

version::Internal.

perl.

Powered by Amon2, 翻訳, サイト. Operated by Japan Perl Association