version-0.74 > version
version-0.74
Other versions:
version-0.77
version-0.70

名前

version - Perl extension for Version Objects

version - バージョンオブジェクトのための Perl 拡張

概要

  use version;
  $version = version->new("12.2.1"); # must be quoted for Perl < 5.8.1
  print $version;               # v12.2.1
  print $version->numify;       # 12.002001
  if ( $version gt "12.2" )     # true

  $alphaver = version->new("1.02_03"); # must be quoted!
  print $alphaver;              # 1.02_0300
  print $alphaver->is_alpha();  # true
  
  $ver = qv("1.2.0");           # v1.2.0

  $perlver = version->new(5.005_03); # must not be quoted!
  print $perlver;               # 5.005030

説明

Overloaded version objects for all modern versions of Perl. This module implements all of the features of version objects which will be part of Perl 5.10.0.

最近の全てのバージョンの Perl 用のオーバーロードされた バージョンオブジェクト。 このモジュールは、Perl 5.10.0 の一部になる予定のバージョンオブジェクトの 全機能を実装しています。

BEST PRACTICES

If you intend for your module to be used by different releases of Perl, and/or for your $VERSION scalar to mean what you think it means, there are a few simple rules to follow:

もしあなたのモジュールを違うバージョンの Perl で使えるようにしたければ、 あるいは $VERSION スカラーがあなたが意図する値を正しく取るようにしたければ、 従うべき単純なルールがいくつかあります:

  • Be consistent

    (一貫性を持って)

    Whichever of the two types of version objects that you choose to employ, you should stick to either "Numeric Versions" or "Extended Versions" and not mix them together. While this is possible, it is very confusing to the average user.

    2 種類のバージョンオブジェクトのどちらを利用することを選んだにしろ、 "Numeric Versions""Extended Versions" のどちらか一方のみを使い続け、 両者を混ぜないようにすべきです。 それは 可能です が、通常のユーザはとても戸惑うことでしょう。

    If you intend to use "Extended Versions", you are strongly encouraged to use the qv() operator with a quoted term, e.g.:

    もし "Extended Versions" を使うのであれば、qv() 演算子をクォート付きの 項を指定して使うことが強く推奨されます。 例えば:

      use version; our $VERSION = qv("1.2.3");

    on a single line as above.

    を上記のように 1 行で記述します。

    At the very least, decide on which of the several ways to initialize your version objects you prefer and stick with it. It is also best to be explicit about what value you intend to assign your version object and to not rely on hidden behavior of the parser.

    最低でも、バージョンオブジェクトを初期化する様々な方法のうち何を 使いたいかを決めて、その方法にこだわってください。 さらに、バージョンオブジェクトに割り当てようとしている値は何なのかに ついて明確に理解していることと、パーサの隠された動作を頼りにしないことが 最重要です。

  • Be careful

    (慎重に)

    If you are using Module::Build or ExtUtils::MakeMaker, so that you can release your module to CPAN, you have to recognize that neither of those programs completely handles version objects natively (yet). If you use version objects with Module::Build, you should add an explicit dependency to the release of version.pm in your Build.PL:

    もし Module::Build や ExtUtils::MakeMaker を使っているのなら、CPAN に モジュールをリリースすることができますが、それらのプログラムがいずれも バージョンオブジェクトを完全に扱うことが (今のところ) できないということに 気付くでしょう。 もし Module::Build と同時にバージョンオブジェクトを使うのであれば、 version.pm の当該バージョンへの依存関係を Build.PL に明示的に 追加しなければなりません:

      my $builder = Module::Build->new(
         ...
         requires => {
             ... ,
             'version'    => 0.50,
             ...,
         },
         ...
      );

    and it should Just Work(TM). Module::Build will [hopefully soon] include full support for version objects; there are no current plans to patch ExtUtils::MakeMaker to support version objects.

    これで動くはずです。 Module::Build は (きっとすぐに) バージョンオブジェクトを完全に サポートするでしょう; バージョンオブジェクトをサポートするために ExtUtils::MakeMaker にパッチを 当てる計画は今のところ存在しません。

version.pm を使うモジュールの使い方

As much as possible, the version.pm module remains compatible with all current code. However, if your module is using a module that has defined $VERSION using the version class, there are a couple of things to be aware of. For purposes of discussion, we will assume that we have the following module installed:

可能な限り、version.pm モジュールは既存の全てのコードとの互換性を保ちます。 ただし、もしあなたのモジュールがバージョンクラスを用いて $VERSION を 定義するモジュールを使用している場合、知っておくべきことがいくつか あります。 議論のため、以下のモジュールがインストールされていることを仮定します:

  package Example;
  use version;  $VERSION = qv('1.2.2');
  ...module code here...
  1;
Numeric versions always work

(数値バージョンは常に動作する)

Code of the form:

以下の形式のコード:

  use Example 1.002003;

will always work correctly. The use will perform an automatic $VERSION comparison using the floating point number given as the first term after the module name (e.g. above 1.002.003). In this case, the installed module is too old for the requested line, so you would see an error like:

は常に正しく動作します。 use はモジュール名の次の項として与えられる 浮動小数点 (例:上述の 1.002.003) を使って自動的に $VERSION の比較を 行います。 この例では、インストールされているモジュールは要求されたコードに 対して古すぎるので、次のようなエラーが表示されるでしょう:

  Example version 1.002003 (v1.2.3) required--this is only version 1.002002 (v1.2.2)...
Extended version work sometimes

(拡張バージョンは時々動作する)

With Perl >= 5.6.2, you can also use a line like this:

Perl >= 5.6.2 では、次のようなコードを使うこともできます:

  use Example 1.2.3;

and it will again work (i.e. give the error message as above), even with releases of Perl which do not normally support v-strings (see "What about v-strings" below). This has to do with that fact that use only checks to see if the second term looks like a number and passes that to the replacement UNIVERSAL::VERSION. This is not true in Perl 5.005_04, however, so you are strongly encouraged to always use a numeric version in your code, even for those versions of Perl which support the extended version.

そしてこれも、たとえ通常は v-文字列 (下記の "What about v-strings" を参照) を サポートしていないバージョンの Perl であっても、正常に動作するでしょう (すなわち、上述のエラーメッセージが表示されます)。 この場合、use は 2 番目の項が 数字のように見える かどうかをチェックし、 それを Replacement UNIVERSAL::VERSIONに渡すだけだという事実が 関わってきます。 しかし、このことは Perl 5.005_04 では正しくなく、そのために extended version をサポートする Perl のバージョンにおいてさえも、コード中では 常に数値バージョンを使うことが 強く推奨 されます。

で、バージョンって何?

For the purposes of this module, a version "number" is a sequence of positive integer values separated by one or more decimal points and optionally a single underscore. This corresponds to what Perl itself uses for a version, as well as extending the "version as number" that is discussed in the various editions of the Camel book.

このモジュールの用途のため、バージョン「番号」は、1つ以上の小数点と 省略可能な 一つのアンダースコアによって区切られる正の整数値とします。 これは Perl 自身がバージョンを表すのに使用するものに対応し、また ラクダ本の各版で論じられた「数字としてのバージョン」を拡張します。

There are actually two distinct kinds of version objects:

実際にはバージョンオブジェクトには 2 種類あります。

  • Numeric Versions

    (数値バージョン)

    Any initial parameter which "looks like a number", see "Numeric Versions". This also covers versions with a single decimal point and a single embedded underscore, see "Numeric Alpha Versions", even though these must be quoted to preserve the underscore formatting.

    「数字のように見える」任意の初期引数 ("Numeric Versions" を参照)。 これは小数点一つや途中にアンダースコア一つを持つバージョンも含みます ("Numeric Alpha Versions" を参照) が、アンダースコアの書式を 保持するにはクォートされなければなりません。

  • Extended Versions

    (拡張バージョン)

    Any initial parameter which contains more than one decimal point and an optional embedded underscore, see "Extended Versions". This is what is commonly used in most open source software as the "external" version (the one used as part of the tag or tarfile name). The use of the exported qv() function also produces this kind of version object.

    2 つ以上の小数点と任意の途中のアンダースコア一つを持つ任意の初期引数 ("Extended Versions" を参照)。 これはほとんどのオープンソースソフトウェアで「外部用」バージョン (タグや tar ファイル名の一部分として使われるもの) として一般的に 使われているものです。 エクスポートされた qv() 関数を使用すると、この種のバージョン オブジェクトが生成されます。

Both of these methods will produce similar version objects, in that the default stringification will yield the version "Normal Form" only if required:

これらのメソッド両方が同様のバージョンオブジェクトを生成します; なぜなら、必要なときにのみデフォルトの文字列化はバージョンの "Normal Form" を生み出すからです:

  $v  = version->new(1.002);     # 1.002, but compares like 1.2.0
  $v  = version->new(1.002003);  # 1.002003
  $v2 = version->new("1.2.3");   # v1.2.3

In specific, version numbers initialized as "Numeric Versions" will stringify as they were originally created (i.e. the same string that was passed to new(). Version numbers initialized as "Extended Versions" will be stringified as "Normal Form".

特に、"Numeric Versions" として初期化されたバージョン番号は 最初に作られた時のもの (つまり、new() に渡されたのと同じ文字列) で 文字列化します。 "Extended Versions" として初期化されたバージョン番号は "Normal Form" として文字列化されます。

数値バージョン

These correspond to historical versions of Perl itself prior to 5.6.0, as well as all other modules which follow the Camel rules for the $VERSION scalar. A numeric version is initialized with what looks like a floating point number. Leading zeros are significant and trailing zeros are implied so that a minimum of three places is maintained between subversions. What this means is that any subversion (digits to the right of the decimal place) that contains less than three digits will have trailing zeros added to make up the difference, but only for purposes of comparison with other version objects. For example:

これらは 5.6.0 より前の Perl 自身の歴史上のバージョンや、$VERSION スカラ用の ラクダルールを踏襲する他のモジュール全てに対応します。 数値バージョンは浮動小数点のように見えるもので初期化されます。 先頭の 0 は 有効で 末尾の 0 は暗黙に仮定されるので、3 点の 最小値は下位バージョン間で保持されます。 これが意味するのは、3 桁より少ない桁数の下位バージョン (小数点より 右の数字) は全て末尾への0の追加によって補われますが、しかしそれは他の バージョンオブジェクトとの比較のためだけです。 例えば:

                                   # Prints     Equivalent to  
  $v = version->new(      1.2);    # 1.2        v1.200.0
  $v = version->new(     1.02);    # 1.02       v1.20.0
  $v = version->new(    1.002);    # 1.002      v1.2.0
  $v = version->new(   1.0023);    # 1.0023     v1.2.300
  $v = version->new(  1.00203);    # 1.00203    v1.2.30
  $v = version->new( 1.002003);    # 1.002003   v1.2.3

All of the preceding examples are true whether or not the input value is quoted. The important feature is that the input value contains only a single decimal. See also "Alpha Versions" for how to handle

入力値がクォートされているかに関わらず、先行例は全て真となります。 重要な特徴として、入力値が一つの小数点を持つことがあります。 扱う方法は "Alpha Versions" も参照してください。

IMPORTANT NOTE: As shown above, if your numeric version contains more than 3 significant digits after the decimal place, it will be split on each multiple of 3, so 1.0003 is equivalent to v1.0.300, due to the need to remain compatible with Perl's own 5.005_03 == 5.5.30 interpretation. Any trailing zeros are ignored for mathematical comparison purposes.

重要な注意:上述で示されているように、数値バージョンが小数点の後に 3 つを 超える有効桁数を含む場合、3 の各倍数で区切られるので 1.0003 は v1.0.300 と 等しくなります。 これは Perl 自身の 5.005_03 == 5.5.30 という解釈との互換性を 維持する必要があるためです。 末尾の 0 は数学的な比較用に全て無視されます。

拡張バージョン

These are the newest form of versions, and correspond to Perl's own version style beginning with 5.6.0. Starting with Perl 5.10.0, and most likely Perl 6, this is likely to be the preferred form. This method normally requires that the input parameter be quoted, although Perl's after 5.8.1 can use v-strings as a special form of quoting, but this is highly discouraged.

これらは最も新しい形式のバージョンで、5.6.0 から始まる Perl 自身の バージョン形式に対応します。 Perl 5.10.0 からは、またほぼ確実に Perl 6 でも、これが 好まれる形式になりそうです。 このメソッドは通常入力引数がクォートされている必要があり、 また 5.8.1 以降の Perl では v-文字列 をクォートの特別形式として 使用することができますが、これは強く非推奨です。

Unlike "Numeric Versions", Extended Versions have more than a single decimal point, e.g.:

"Numeric Versions" と違って、拡張バージョンは 2 つ以上の小数点を 持ちます。 例えば:

                                   # Prints
  $v = version->new( "v1.200");    # v1.200.0
  $v = version->new("v1.20.0");    # v1.20.0
  $v = qv("v1.2.3");               # v1.2.3
  $v = qv("1.2.3");                # v1.2.3
  $v = qv("1.20");                 # v1.20.0

In general, Extended Versions permit the greatest amount of freedom to specify a version, whereas Numeric Versions enforce a certain uniformity. See also "New Operator" for an additional method of initializing version objects.

一般的に、拡張バージョンは最も高い自由度でバージョンを指定でき、その 一方で数値バージョンは一定の統一性を強制します。 バージョンオブジェクトのもう一つの補助的な初期化メソッドについては "New Operator" も参照してください。

Just like "Numeric Versions", Extended Versions can be used as "Alpha Versions".

"Numeric Versions" と全く同様に、拡張バージョンは "Alpha Versions" として 使用することができます。

数値αバージョン

The one time that a numeric version must be quoted is when a alpha form is used with an otherwise numeric version (i.e. a single decimal point). This is commonly used for CPAN releases, where CPAN or CPANPLUS will ignore alpha versions for automatic updating purposes. Since some developers have used only two significant decimal places for their non-alpha releases, the version object will automatically take that into account if the initializer is quoted. For example Module::Example was released to CPAN with the following sequence of $VERSION's:

かつて数値バージョンが必ずクォートされていなければならなかったのは、 アルファ形式が他の数値バージョン (すなわち小数点が一つ) と一緒に 使われていたときです。 これはよく CPAN リリースに使われており、そこで CPAN や CPANPLUS は自動アップデートのためにアルファバージョンを無視します。 非アルファリリースに小数の有効桁数を2としていた開発者がいたため、 バージョンオブジェクトは初期化子がクォートされていれば自動的に それを考慮します。 例えば、Module::Example が以下の $VERSION 系列で CPAN に リリースされたとします:

  # $VERSION    Stringified
  0.01          0.01
  0.02          0.02
  0.02_01       0.02_01
  0.02_02       0.02_02
  0.03          0.03
  etc.

The stringified form of numeric versions will always be the same string that was used to initialize the version object.

数値バージョンの文字列化形式は、常にバージョンオブジェクトの初期化に 使われるのと同じ文字列です。

オブジェクトメソッド

Overloading has been used with version objects to provide a natural interface for their use. All mathematical operations are forbidden, since they don't make any sense for base version objects. Consequently, there is no overloaded numification available. If you want to use a version object in a numeric context for some reason, see the numify object method.

バージョンオブジェクトの利用にとって自然なインタフェースを提供するために、 オーバーロードが使われてきました。 数学的な演算は全て、ベースのバージョンオブジェクトに対して意味を 成さないので、禁止されています。 その結果、オーバーロードされた数値化は存在せず利用できません。 もし何らかの理由でバージョンオブジェクトを数値コンテキストで使用したい 場合は、オブジェクトメソッドの numify を参照してください。

  • New Operator

    (new 演算子)

    Like all OO interfaces, the new() operator is used to initialize version objects. One way to increment versions when programming is to use the CVS variable $Revision, which is automatically incremented by CVS every time the file is committed to the repository.

    全ての OO インタフェースと同様に、new() 演算子はバージョンオブジェクトを 初期化するために使われます。 プログラミング時にバージョンをインクリメントするための方法の一つは CVS 変数の $Revision を使うことです。 $Revision はファイルがリポジトリにコミットされた際に毎回 CVS によって 自動的にインクリメントされます。

    In order to facilitate this feature, the following code can be employed:

    この機能を容易に行うために、以下のコードが利用できます:

      $VERSION = version->new(qw$Revision: 2.7 $);

    and the version object will be created as if the following code were used:

    これにより、以下のコードが使われたかのようにバージョンオブジェクトが 作成されます:

      $VERSION = version->new("v2.7");

    In other words, the version will be automatically parsed out of the string, and it will be quoted to preserve the meaning CVS normally carries for versions. The CVS $Revision$ increments differently from numeric versions (i.e. 1.10 follows 1.9), so it must be handled as if it were a "Extended Version".

    言い換えると、構文解析により文字列からバージョンが自動的に取り出され、 CVS が通常バージョンで伝える意味を保つためにそれがクォートされます。 CVS の $Revision$ は数値バージョンとは異なった方法でインクリメントされる (すなわち 1.9 の後に 1.10 が続く) ので、それが "Extended Versions" で あるかのように扱わなければなりません。

    A new version object can be created as a copy of an existing version object, either as a class method:

    新しいバージョンオブジェクトは既存のバージョンオブジェクトのコピーとして 作成可能で、クラスメソッドとして作成する:

      $v1 = version->new(12.3);
      $v2 = version->new($v1);

    or as an object method:

    ことも、あるいはオブジェクトメソッドとして作成する:

      $v1 = version->new(12.3);
      $v2 = $v1->new(12.3);

    and in each case, $v1 and $v2 will be identical. NOTE: if you create a new object using an existing object like this:

    こともでき、それぞれの例において、$v1 と $v2 は同一です。 注意: もし新しいオブジェクトを次のように既存のオブジェクトを使って 作成する場合:

      $v2 = $v1->new();

    the new object will not be a clone of the existing object. In the example case, $v2 will be an empty object of the same type as $v1.

    新しいオブジェクトは既存のオブジェクトのクローンには なりません。 この例では、$v2 は $v1 と同じ種類の空のオブジェクトになります。

  • qv()

    An alternate way to create a new version object is through the exported qv() sub. This is not strictly like other q? operators (like qq, qw), in that the only delimiters supported are parentheses (or spaces). It is the best way to initialize a short version without triggering the floating point interpretation. For example:

    新しいバージョンオブジェクトを作成する別の方法に、エクスポートされた qv() 関数を使う方法があります。 これは、利用可能なデリミタが丸カッコ (またはスペース) のみであるという点で、 厳密には他の q? 演算子 (qq, qw など) とは似ていません。 これは、小数点解釈を引き起こすことなしに短いバージョンを初期化するための 最良の方法です。 例えば:

      $v1 = qv(1.2);         # 1.2.0
      $v2 = qv("1.2");       # also 1.2.0

    As you can see, either a bare number or a quoted string can usually be used interchangably, except in the case of a trailing zero, which must be quoted to be converted properly. For this reason, it is strongly recommended that all initializers to qv() be quoted strings instead of bare numbers.

    ご覧の通り、裸の数値またはクォートされた文字列は通常交換して 使用できます。 ただし、末尾に 0 があるケースは、正しく変換するためにクォートされる必要が あるので例外です。 この理由のため、qv() への全ての初期化子は裸の数値のかわりに クォートされた文字列とすることが強く推奨されます。

    To prevent the qv() function from being exported to the caller's namespace, either use version with a null parameter:

    qv() 関数が呼び出し側の名前空間にエクスポートされるのを防ぐために、空の 引数で use version を呼び出すか:

      use version ();

    or just require version, like this:

    あるいは単に require version を行うか:

      require version;

    Both methods will prevent the import() method from firing and exporting the qv() sub. This is true of subclasses of version as well, see SUBCLASSING for details.

    のいずれかを行ってください。 両方のメソッドとも import() メソッドが起動して qv() サブルーチンを エクスポートするのを防ぎます。 このことは version のサブクラスでも同じように成り立ちます。 詳しくは SUBCLASSING を参照してください。

For the subsequent examples, the following three objects will be used:

以降の例では、以下の 3 つのオブジェクトが使われます:

  $ver   = version->new("1.2.3.4"); # see "Quoting" below
  $alpha = version->new("1.2.3_4"); # see "Alpha versions" below
  $nver  = version->new(1.002);     # see "Numeric Versions" above
  • Normal Form

    (正規形式)

    For any version object which is initialized with multiple decimal places (either quoted or if possible v-string), or initialized using the qv() operator, the stringified representation is returned in a normalized or reduced form (no extraneous zeros), and with a leading 'v':

    複数の小数点 (クォートされたものか可能であればv-文字列) を用いて、 もしくは qv() 演算子を用いて初期化されたバージョンオブジェクトのために、 文字列化された表現形式が正規化もしくは縮小された形式 (余分なゼロを削除) で、 先頭に 'v' が付いて返されます:

      print $ver->normal;         # prints as v1.2.3.4
      print $ver->stringify;      # ditto
      print $ver;                 # ditto
      print $nver->normal;        # prints as v1.2.0
      print $nver->stringify;     # prints as 1.002, see "Stringification" 

    In order to preserve the meaning of the processed version, the normalized representation will always contain at least three sub terms. In other words, the following is guaranteed to always be true:

    処理されたバージョンの意味を保つために、正規化された表現形式は必ず最低 3 つの下位項を持たなければなりません。 言い換えると、以下のコードは常に真となることが保証されます:

      my $newver = version->new($ver->stringify);
      if ($newver eq $ver ) # always true
        {...}
  • Numification

    (数値化)

    Although all mathematical operations on version objects are forbidden by default, it is possible to retrieve a number which corresponds to the version object through the use of the $obj->numify method. For formatting purposes, when displaying a number which corresponds a version object, all sub versions are assumed to have three decimal places. So for example:

    バージョンオブジェクトに対する数学的な演算はデフォルトでは全て 禁止されていますが、$obj->numify メソッドを使うことでそのバージョン オブジェクトに対応した数値を取り出すことが可能です。 フォーマッティングのために、バージョンオブジェクトに対応する数値を 表示する際には、下位バージョンは全て 3 桁あると仮定されます。 従って、例を挙げると以下のようになります:

      print $ver->numify;         # prints 1.002003004
      print $nver->numify;        # prints 1.002

    Unlike the stringification operator, there is never any need to append trailing zeros to preserve the correct version value.

    文字列化演算子と違って、正しいバージョン値を保持するために末尾のゼロを 追加する必要は全くありません。

  • Stringification

    (文字列化)

    The default stringification for version objects returns exactly the same string as was used to create it, whether you used new() or qv(), with one exception. The sole exception is if the object was created using qv() and the initializer did not have two decimal places or a leading 'v' (both optional), then the stringified form will have a leading 'v' prepended, in order to support round-trip processing.

    バージョンオブジェクトの文字列化のデフォルトは、 new() によるか qv() によるかに関わらず、 オブジェクトを作成したのと全く同じ文字列となりますが、ひとつの例外が あります。 唯一の例外は、オブジェクトが qv() を使って作成され、 初期化子が 2 つの十進数がなかったり、先頭の 'v' がない場合 (これらは両方ともオプションです)、循環処理に対応するために、 文字列化形式は先頭に 'v' がつきます。

    For example:

    例えば:

      Initialized as          Stringifies to
      ==============          ==============
      version->new("1.2")       1.2
      version->new("v1.2")     v1.2
      qv("1.2.3")               1.2.3
      qv("v1.3.5")             v1.3.5
      qv("1.2")                v1.2   ### exceptional case 

    See also UNIVERSAL::VERSION, as this also returns the stringified form when used as a class method.

    UNIVERSAL::VERSION も参照してください; これも、クラスメソッドとして 使われたときには文字列化形式を返します。

  • Comparison operators

    (比較演算子)

    Both cmp and <=> operators perform the same comparison between terms (upgrading to a version object automatically). Perl automatically generates all of the other comparison operators based on those two. In addition to the obvious equalities listed below, appending a single trailing 0 term does not change the value of a version for comparison purposes. In other words "v1.2" and "1.2.0" will compare as identical.

    cmp<=> は両方とも同じ比較を項間で行います (自動的に バージョンオブジェクトにアップグレードします)。 それら 2 つに基づいて、Perl は他の比較演算子を全て自動的に生成します。 以下に挙げられている明らかな等値性に加えて、末尾に 0 の項を一つ追加しても 比較用のバージョン値は変化しません。 言い換えると、"v1.2" と"1.2.0" の比較は同一と見なされます。

    For example, the following relations hold:

    例えば、以下の関係が維持されます:

      As Number        As String           Truth Value
      -------------    ----------------    -----------
      $ver >  1.0      $ver gt "1.0"       true
      $ver <  2.5      $ver lt             true
      $ver != 1.3      $ver ne "1.3"       true
      $ver == 1.2      $ver eq "1.2"       false
      $ver == 1.2.3.4  $ver eq "1.2.3.4"   see discussion below

    It is probably best to chose either the numeric notation or the string notation and stick with it, to reduce confusion. Perl6 version objects may only support numeric comparisons. See also Quoting.

    数値記法か文字列記法のどちらかを選んでそれを使い続けることが、混乱を 避けるためにはおそらくベストでしょう。 Perl6 のバージョンオブジェクトは数値比較のみを サポートする かもしれませんQuoting も参照してください。

    WARNING: Comparing version with unequal numbers of decimal points (whether explicitly or implicitly initialized), may yield unexpected results at first glance. For example, the following inequalities hold:

    警告:(初期化が明示的か暗黙的かに関わらず) 小数点の数が異なるバージョンの 比較は一見すると期待しない結果を生み出すかもしれません。 例えば、以下の非等値性が成り立ちます:

      version->new(0.96)     > version->new(0.95); # 0.960.0 > 0.950.0
      version->new("0.96.1") < version->new(0.95); # 0.096.1 < 0.950.0

    For this reason, it is best to use either exclusively "Numeric Versions" or "Extended Versions" with multiple decimal points.

    この理由のため、"Numeric Versions""Extended Versions" のどちらかを 排他的に、かつ複数の小数点を付けて使うことがベストです。

  • Logical Operators

    If you need to test whether a version object has been initialized, you can simply test it directly:

    もしバージョンオブジェクトが初期化されているかどうかを確かめたければ、 簡単に直接テストできます:

      $vobj = version->new($something);
      if ( $vobj )   # true only if $something was non-blank

    You can also test whether a version object is an "Alpha version", for example to prevent the use of some feature not present in the main release:

    また、例えばメインリリースでは提供されない機能の使用を防ぐといった 目的のために、バージョンオブジェクトが "Alpha Versions" であるかどうかを 確かめるには以下のようにします:

      $vobj = version->new("1.2_3"); # MUST QUOTE
      ...later...
      if ( $vobj->is_alpha )       # True

クォート

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 qv() operator. In all cases, a floating point number passed to version->new() will be identically converted whether or not the value itself is quoted. This is not true for qv(), however, when trailing zeros would be stripped on an unquoted input, which would result in a very different version object.

Perl がパースとトークン化を行うプログラムの仕組みのため、意図した バージョンに正しくパースするために、特に qv() 演算子を使用する際には、 特定の初期値は 必ず クォートしなければなりません。 全てのケースにおいて、version->new() に渡される浮動小数点数の値は、その値が クォートされていようとなかろうと同一に変換されます。 しかし、qv() では、クォートされていない入力で末尾のゼロが 抜け落ちてしまう場合にはそのようにならず、全く異なる バージョンオブジェクトが結果として返されます。

In addition, in order to be compatible with earlier Perl version styles, any use of versions of the form 5.006001 will be translated as v5.6.1. In other words, a version with a single decimal point will be parsed as implicitly having three digits between subversions, but only for internal comparison purposes.

加えて、以前の Perl のバージョンスタイルと互換性を保つために、5.006001 と いう形式のバージョンを使用すると全て v5.6.1 のように変換されます。 言い換えると、小数点が 1 つのバージョンは、下位バージョン間には 3 桁の 数字が暗黙的に存在するようにパースされますが、その目的は内部比較のみです。

The complicating factor is that in bare numbers (i.e. unquoted), the underscore is a legal numeric character and is automatically stripped by the Perl tokenizer before the version code is called. However, if a number containing one or more decimals and an underscore is quoted, i.e. not bare, that is considered a "Alpha Version" and the underscore is significant.

ややこしくしている要因は、裸の数値 (すなわちクォートされていないもの) では アンダースコアは正当な数値用の文字であって、バージョンコードが 呼び出される前に Perl のトークナイザによって自動的に剥ぎ取られることです。 しかしながら、もし数値が 1 つ以上の小数を含んでいてアンダースコアが クォートされている場合、すなわち裸の数値ではない場合、 "Alpha Version" であると見なされてアンダースコアが有効になります。

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 will be 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-文字列はどう?

Beginning with Perl 5.6.0, an alternate method to code arbitrary strings of bytes was introduced, called v-strings. They were intended to be an easy way to enter, for example, Unicode strings (which contain two bytes per character). Some programs have used them to encode printer control characters (e.g. CRLF). They were also intended to be used for $VERSION, but their use as such has been problematic from the start.

Perl 5.6.0 以降では、任意のバイト列をコーディングする代替方法が導入され、 v-文字列と呼ばれています。 v-文字列は、例えば (1 文字あたり 2 バイトを使う) Unicode 文字列のようなものを入力するのが簡単なようになっています。 プリンタ制御文字 (すなわち CRLF) をエンコードするためにv-文字列を 使っているプログラムもあります。 v-文字列は $VERSION のために使われるようにも意図されていましたが、 そのような使用は初めから問題をはらんでいました。

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 (especially the leading 'v' style), since the meaning will change depending on which Perl you are running. It is better to directly use "Extended Versions" to ensure the proper interpretation.

しかしながら、バージョンオブジェクトを初期化するために裸のv-文字列を 使用することは、実行している Perl が何かに依存して意味が変わるので、 どのような状況であっても 強く 非推奨です (特に先頭に'v' が付く スタイルは)。 "Extended Versions" を直接使って適切な解釈を確実にすることが より良いでしょう。

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' の文字がつきます; ときどき、これが先頭に付いていたかを確認することが不可能であるという 単純な理由によります。

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

There are two types of Version Objects:

2 種類のバージョンオブジェクトが存在します。

  • Ordinary versions

    (通常のバージョン)

    These are the versions that normal modules will use. Can contain as many subversions as required. In particular, those using RCS/CVS can use the following:

    これらは通常のモジュールが使うバージョンです。 必要なだけ多くの下位バージョンを含むことができます。 特に、RCS/CVS を使っている人は以下のコードを使うことができます:

      $VERSION = version->new(qw$Revision: 2.7 $);

    and the current RCS Revision for that file will be inserted automatically. If the file has been moved to a branch, the Revision will have three or more elements; otherwise, it will have only two. This allows you to automatically increment your module version by using the Revision number from the primary file in a distribution, see "VERSION_FROM" in ExtUtils::MakeMaker.

    これでそのファイルに対する現在の RCS Revision が自動的に挿入されます。 もしファイルがブランチに移動されれば Revision は 3 つかそれ以上の要素を 持ち、そうでなければ 2 つのみを持つでしょう。 これはディストリビューション内のプライマリファイルから Revision 番号を 使うことでモジュールバージョンを自動的にインクリメントすることを 可能にします ("VERSION_FROM" in ExtUtils::MakeMaker を参照)。

  • Alpha Versions

    (αバージョン)

    For module authors using CPAN, the convention has been to note unstable releases with an underscore in the version string, see CPAN. Alpha releases will test as being newer than the more recent stable release, and less than the next stable release. For example:

    CPAN を使用しているモジュール作者の間で、不安定なリリースを示すために バージョン文字列内にアンダースコアを付ける慣習ができています (CPAN を 参照)。 αリリースは、その直前の安定リリースよりも新しく、次の安定リリースよりも 小さく判定されます。 例えば:

      $alphaver = version->new("12.03_01"); # must be quoted

    obeys the relationship

    これは次の関係に従います。

      12.03 < $alphaver < 12.04

    Alpha versions with a single decimal point will be treated exactly as if they were "Numeric Versions", for parsing and output purposes. The underscore will be output when an alpha version is stringified, in the same place as it was when input.

    小数点を 1 つ持つαバージョンは、パースと出力において、完全に "Numeric Versions" であるかのように扱われます。 αバージョンが文字列化されたときには、アンダースコアが入力時と同じ位置に 出力されます。

    Alpha versions with more than a single decimal point will be treated exactly as if they were "Extended Versions", and will display without any trailing (or leading) zeros, in the "Version Normal" form. For example,

    2 つ以上の小数点を持つαバージョンは完全に "Extended Versions" で あるかのように取り扱われ、バージョンの "Normal form" で、末尾(あるいは 先頭)のゼロ無しで表示されます。 例えば:

      $newver = version->new("12.3.1_1");
      print $newver; # v12.3.1_1

代替 UNIVERSAL::VERSION

In addition to the version objects, this modules also replaces the core UNIVERSAL::VERSION function with one that uses version objects for its comparisons. The return from this operator is always the stringified form, but the warning message generated includes either the stringified form or the normal form, depending on how it was called.

バージョンオブジェクトに加えて、このモジュールは比較のためにコアの UNIVERSAL::VERSION 関数をバージョンオブジェクトを使うものに 置き換えることも行います。 この演算子から返されるものは常に文字列化された形式ですが、 生成された警告メッセージは、どのように呼び出されたかに依存して、 文字列化形式か Normal Form のどちらかになります。

For example:

例えば:

  package Foo;
  $VERSION = 1.2;

  package Bar;
  $VERSION = "1.3.5"; # works with all Perl's (since it is quoted)

  package main;
  use version;

  print $Foo::VERSION; # prints 1.2

  print $Bar::VERSION; # prints 1.003005

  eval "use foo 10";
  print $@; # prints "foo version 10 required..."
  eval "use foo 1.3.5; # work in Perl 5.6.1 or better
  print $@; # prints "foo version 1.3.5 required..."

  eval "use bar 1.3.6";
  print $@; # prints "bar version 1.3.6 required..."
  eval "use bar 1.004"; # note numeric version
  print $@; # prints "bar version 1.004 required..."

IMPORTANT NOTE: This may mean that code which searches for a specific string (to determine whether a given module is available) may need to be changed. It is always better to use the built-in comparison implicit in use or require, rather than manually poking at class-VERSION> and then doing a comparison yourself.

重要な注意: (与えられたモジュールが利用可能かどうかを決定するために) 特定の文字列を検索するためのコードは変更が必要かもしれないことを 意味します。 手動で class-VERSION> を使ってから自分で比較を行うより、 userequire で暗黙に使われる組み込みの比較を使う方が 常に優れています。

The replacement UNIVERSAL::VERSION, when used as a function, like this:

UNIVERSAL::VERSION の代替物は、以下のように関数として使われた際:

  print $module->VERSION;

will also exclusively return the stringified form. See Stringification for more details.

これも文字列化形式のみを返します。 更なる詳細については Stringification を参照してください。

サブクラス化

This module is specifically designed and tested to be easily subclassed. In practice, you only need to override the methods you want to change, but you have to take some care when overriding new() (since that is where all of the parsing takes place). For example, this is a perfect acceptable derived class:

このモジュールは簡単にサブクラス化ができるように明確に設計やテストがさ れています。 実際には、変更したいメソッドをオーバーライドするだけで OK ですが、 new() をオーバーライドする際には注意が必要です (パースが全て行われる 場所なので)。 例えば、これは完全に条件を満たしている派生クラスです:

  package myversion;
  use base version;
  sub new { 
      my($self,$n)=@_;
      my $obj;
      # perform any special input handling here
      $obj = $self->SUPER::new($n);
      # and/or add additional hash elements here
      return $obj;
  }

See also version::AlphaBeta on CPAN for an alternate representation of version strings.

バージョン文字列の代替の表現形式については CPAN の version::AlphaBeta も 参照してください。

NOTE: Although the qv operator is not a true class method, but rather a function exported into the caller's namespace, a subclass of version will inherit an import() function which will perform the correct magic on behalf of the subclass.

注意: qv 演算子は真のクラスメソッドではなく、むしろ呼び出し元の 名前空間にエクスポートされた関数で、version のサブクラスは、その サブクラスに代わって正しいマジックを実行する import() 関数を継承します。

EXPORT

qv - Extended Version initialization operator

qv - 拡張バージョン初期化演算子

作者

John Peacock <jpeacock@cpan.org>

SEE ALSO

perl.